### XML Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyStatisticPublic Example of a successful response from the QueryGateVerifyStatisticPublic API in XML format. This illustrates the same data as the JSON example but in an XML structure. ```xml OK 请求成功 8906582E-6722 20 20 0 0 20220103 0 20 0 ``` -------------------------------- ### GetAuthToken Response Example (XML) Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetAuthToken Example of the GetAuthToken API response in XML format. This provides an alternative structure for parsing the authentication token retrieval results. ```xml OK 请求成功 8906582E-6722 agag**** aweghd**** ``` -------------------------------- ### GetAuthToken Response Example (JSON) Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetAuthToken Example of the GetAuthToken API response in JSON format. This is useful for understanding the structure of successful authentication token retrieval. ```json { "Code": "OK", "Message": "请求成功", "RequestId": "8906582E-6722", "TokenInfo": { "AccessToken": "agag****", "JwtToken": "aweghd****" } } ``` -------------------------------- ### JSON Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyStatisticPublic Example of a successful response from the QueryGateVerifyStatisticPublic API in JSON format. This shows the total call counts and daily statistics. ```json { "Code": "OK", "Message": "请求成功", "RequestId": "8906582E-6722", "Data": { "TotalFail": 20, "Total": 20, "TotalSuccess": 0, "TotalUnknown": 0, "DayStatistic": [ { "StatisticDateStr": "20220103", "TotalSuccess": 0, "TotalFail": 20, "TotalUnknown": 0 } ] } } ``` -------------------------------- ### CreateVerifyScheme Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateSchemeConfig This is a sample JSON response for the CreateVerifyScheme API call. It includes request ID, message, model details, code, and success status. ```json { "RequestId": "B95B36EC-8108-4479-D3AA-2BB27F9B155A\n", "Message": "成功", "Model": { "SchemeCode": "FA100000168468035" }, "Code": "OK", "Success": false } ``` -------------------------------- ### XML Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyBillingPublic This is a successful response from the QueryGateVerifyBillingPublic API in XML format, detailing billing information including total amount and scene-specific costs. ```xml OK 请求成功 8906582E-6722 92760 1234 74 15810**** 0.02 1.48 本机号码校验 FC100000038194004 阿里云 阿里云通信 www.example.com ``` -------------------------------- ### JSON Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyBillingPublic This is a successful response from the QueryGateVerifyBillingPublic API in JSON format, showing billing details for a specific scene. ```json { "Code": "OK", "Message": "successful", "RequestId": "8906582E-6722", "Data": { "AmountSum": "1234", "SceneBillingList": [ { "Add": "74", "SinglePrice": "0.02", "Amount": "1.48", "ItemName": "本机号码校验", "SceneCode": "FC100000038194004", "AppName": "阿里云", "SceneName": "阿里云通信" } ] } } ``` -------------------------------- ### GetMobile API JSON Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetMobile Example of a successful response from the GetMobile API in JSON format. This shows the structure of the returned code, message, request ID, and mobile result. ```json { "Code": "OK", "Message": "请求成功", "RequestId": "8906582E-6722", "GetMobileResultDTO": { "Mobile": "139****1234" } } ``` -------------------------------- ### GetMobile API XML Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetMobile Example of a successful response from the GetMobile API in XML format. This illustrates the equivalent data structure as the JSON response, including code, message, request ID, and mobile result. ```xml 请求成功 8906582E-6722 OK 150****0000 ``` -------------------------------- ### CreateVerifyScheme Response XML Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateVerifyScheme Example XML response for the CreateVerifyScheme API call, detailing the status and scheme information. ```xml OK 请求成功 8906582E6722 FC10001287**** ``` -------------------------------- ### CheckSmsVerifyCode API Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CheckSmsVerifyCode This is an example of a successful response from the CheckSmsVerifyCode API. It includes details about access denial, message status, model data, response code, success status, and request ID. ```json { "AccessDeniedDetail": "无", "Message": "成功", "Model": { "OutId": "1212312", "VerifyResult": "PASS" }, "Code": "OK", "Success": true, "RequestId": "CF8854E5-DB21-3E5D-A9B1-DDC752FD7384" } ``` -------------------------------- ### QuerySendDetails API Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QuerySendDetails This is a sample JSON response from the QuerySendDetails API. It includes details about the total count of records, message status, and an array of model objects, each containing information about a sent message. ```json { "AccessDeniedDetail": "无", "TotalCount": 42, "Message": "成功", "Model": [ { "TemplateCode": "SMS_12231****\n", "ReceiveDate": "2019-01-08 16:44:13\n", "PhoneNum": "1390000****\n", "Content": "203160", "SendStatus": 3, "OutId": "12131231", "SendDate": "2019-01-08 16:44:13\n", "ErrCode": "DELIVERED" } ], "Code": "OK", "Success": true } ``` -------------------------------- ### GetSmsAuthTokens Response (XML) Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetSmsAuthTokens Example of a successful response from the GetSmsAuthTokens API in XML format. This includes the authorization token and related security credentials. ```xml OK 请求成功 8906582E-6722 FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c**** VboZ4xbZ**** STS.NSqC**** 1631526326000 CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML/2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx**** ``` -------------------------------- ### GetSmsAuthTokens Response (JSON) Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetSmsAuthTokens Example of a successful response from the GetSmsAuthTokens API in JSON format. This includes the authorization token and related security credentials. ```json { "Code": "OK", "Message": "请求成功", "RequestId": "8906582E-6722", "Data": { "BizToken": "FZSMeRbLCiapIBo65NXNHvGbkGDmhs23XWTZDOtZN0g5n/kqSc2FU27Gc9YhGb6dNn9/L9ZXSYiIB6C6LMLQJjyXjRzt5v6pzZXqnjO4cSuPWYUxJvdc8l8OpucEYe8Mx17HxsHDzj0VC4D5+atcrTpJE6jQ7e2QVNjZIPMwsfxELjQS7c****", "StsAccessKeySecret": "VboZ4xbZ****", "StsAccessKeyId": "STS.NSqC****", "ExpireTime": 1631526326000, "StsToken": "CAISiQJ1q6Ft5B2yfSjIr5DEDP/BurtW9PemMEfBrEpsOr5K17XjuDz2IHtLfXFsBusYt/U2nWpX5v4clrxIToR7SFbFY9pb6ZhazBisebDGv8HtR3TcFEjiSwapEBfe8JL4QYeQFaHwGJqEb1TDiVUAo9/TfimjWFqIKICAjYUdAP0cQgi/a0gtZr4UXHwAzvUXLnzML2gHwf3i27LdipStxF7lHl05NbUoKTeyGKH3AGqlLVF9tite8f9NpczBvolDYfpht4RX7HazStd5yJN8KpLl6Fe8V/FxIrGXAAJv0rdbbOFq4Q1c18hOLJHAKtfsvXmlPNpsevfmpnsx****" } } ``` -------------------------------- ### GetPhoneWithToken API Response Example Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetPhoneWithToken This JSON object represents a successful response from the GetPhoneWithToken API, containing the status code, message, request ID, and the retrieved mobile number. ```json { "Code": "OK", "Message": "请求成功", "RequestId": "0F335F48-****-****-****-CA7914FE5D77", "Data": { "Mobile": "13900001234" } } ``` -------------------------------- ### CreateVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateVerifyScheme Creates a verification scheme to identify authentication scenarios for an App. A verification scheme typically corresponds to an App name, App package name, package signature, etc. Different access points require different parameters. Call this interface to create a verification scheme. ```APIDOC ## CreateVerifyScheme ### Description Creates a verification scheme to identify authentication scenarios for an App. A verification scheme typically corresponds to an App name, App package name, package signature, etc. Different access points require different parameters. Call this interface to create a verification scheme. ### Method POST ### Endpoint /api/createverifyscheme ### Parameters #### Query Parameters - **** (string) - Required - Description ### Request Example { "example": "request body" } ### Response #### Success Response (200) - **** (string) - Description #### Response Example { "example": "response body" } ``` -------------------------------- ### CreateVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateVerifyScheme Creates a verification scheme for authentication purposes. This API allows configuration for various platforms like Android, iOS, and H5, and supports different authentication types. ```APIDOC ## POST /CreateVerifyScheme ### Description Creates a verification scheme for authentication purposes. This API allows configuration for various platforms like Android, iOS, and H5, and supports different authentication types. ### Method POST ### Endpoint /CreateVerifyScheme ### Parameters #### Request Body - **SchemeName** (string) - Required - Scheme name. - **AppName** (string) - Required - App name. - **OsType** (string) - Required - Terminal operating system type (e.g., iOS, Android, Harmony). - **PackName** (string) - Optional - Package name, required if osType is Android. Must be 1-128 characters. - **PackSign** (string) - Optional - Package signature, required if osType is Android. Must be 32 alphanumeric characters. - **BundleId** (string) - Optional - Bundle ID, required if osType is iOS. Must be 1-128 characters. - **Origin** (string) - Optional - H5 scheme page origin address (domain level recommended). - **Url** (string) - Optional - H5 scheme page address. - **IpWhiteList** (string) - Optional - IP whitelist. - **CmApiCode** (integer) - Optional - China Mobile channel Code. - **CuApiCode** (integer) - Optional - China Unicom channel Code. - **CtApiCode** (integer) - Optional - China Telecom channel Code. - **SceneType** (string) - Optional - Scheme type. - **Email** (string) - Optional - Email address for receiving key. - **AuthType** (string) - Optional - Authentication type, comma-separated (e.g., '1,2'). - **SmsSignName** (string) - Optional - Bound SMS sign, valid only if AuthType includes '2' (SMS authentication). - **HmPackageName** (string) - Optional - Package name, required if osType is Harmony. Must start with a letter, 7-127 characters. - **HmSignName** (string) - Optional - Package signature, required if osType is Harmony. Must be 64 alphanumeric characters. - **HmAppIdentifier** (string) - Optional - AppId, required if osType is Harmony. Must be 19 digits. ### Response #### Success Response (200) - **Message** (string) - Description of the status code. - **RequestId** (string) - Unique ID for the request. - **GateVerifySchemeDTO** (object) - Structure containing scheme details. - **SchemeCode** (string) - The generated scheme code. - **HttpStatusCode** (integer) - HTTP status code. - **Code** (string) - Status code (e.g., OK). - **Success** (boolean) - Indicates if the request was successful. ### Request Example ```json { "SchemeName": "一键登录认证方案", "AppName": "阿里云通信", "OsType": "iOS", "BundleId": "example.aliyundoc.com" } ``` ### Response Example ```json { "Message": "请求成功", "RequestId": "A1E75E69-3049-5FDB-A376-D745837CD2B1", "GateVerifySchemeDTO": { "SchemeCode": "FC10001287****" }, "HttpStatusCode": 200, "Code": "OK", "Success": true } ``` ### Error Handling - **SchemeNumberOverLimit**: The maximum number of schemes is exceeded. - **BundleIdConflict**: The specified bundleId already exists. - **InvalidParameters**: The specified parameter is not valid. - **InvalidAccountStatus**: Your account has been suspended. - **RamPermissionDeny**: The user is not authorized to operate on the specified resource. - **PackageSignedConflict**: The specified package signed already exists. - **Unsupported.Account**: Your account has not activated the product. ``` -------------------------------- ### DescribeVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/DescribeVerifyScheme Retrieves authentication scheme keys and other parameters necessary for calling other APIs within the Dypnsapi service. ```APIDOC ## DescribeVerifyScheme - Get Authentication Scheme Key ### Description This API is used to obtain authentication scheme keys and other parameters required when calling other API interfaces. It provides essential information for secure API interactions. ### Method GET ### Endpoint /api/describeverifyscheme ### Parameters #### Query Parameters - **SchemeId** (string) - Required - The ID of the authentication scheme. - **Type** (string) - Required - The type of the authentication scheme. ### Request Example ```json { "SchemeId": "your_scheme_id", "Type": "your_scheme_type" } ``` ### Response #### Success Response (200) - **VerifySchemeList** (array) - A list of authentication schemes. - **SchemeId** (string) - The ID of the authentication scheme. - **SchemeName** (string) - The name of the authentication scheme. - **SchemeType** (string) - The type of the authentication scheme. - **PublicKey** (string) - The public key for the authentication scheme. - **CreateTime** (string) - The creation time of the authentication scheme. - **UpdateTime** (string) - The last update time of the authentication scheme. #### Response Example ```json { "VerifySchemeList": [ { "SchemeId": "your_scheme_id", "SchemeName": "Your Scheme Name", "SchemeType": "your_scheme_type", "PublicKey": "your_public_key", "CreateTime": "2023-01-01T10:00:00Z", "UpdateTime": "2023-01-01T10:00:00Z" } ] } ``` ### QPS Limit This interface has a single-user QPS limit of 100 times/second. Calls exceeding this limit will be rate-limited, which may affect your business. Please call reasonably. ``` -------------------------------- ### CreateSchemeConfig Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateSchemeConfig Creates a new verification scheme configuration. This API allows you to set up configurations for different platforms like Android, iOS, and H5. ```APIDOC ## CreateSchemeConfig ### Description Creates a new verification scheme configuration. This API allows you to set up configurations for different platforms like Android, iOS, and H5. ### Method POST ### Endpoint /CreateSchemeConfig ### Parameters #### Request Body - **SchemeName** (string) - Required - The name of the scheme, composed of Chinese and English letters, with a length limit of 10 characters. - **Platform** (string) - Required - The application platform for the scheme. Allowed values: Android, iOS. - **AppName** (string) - Required - The App name for the scheme, composed of Chinese and English letters, with a length limit of 20 characters. - **AndroidPackageName** (string) - Optional - Package name, required when Platform is Android. Composed of numbers, letters, hyphens (-), underscores, or dots, with a length limit of 1~128 characters. - **AndroidPackageSign** (string) - Optional - Package signature, required when Platform is Android. Composed of numbers and letters, with a length of 32 characters. - **IosBundleId** (string) - Optional - BundleID, required when Platform is iOS. Composed of numbers, letters, hyphens (-), underscores, or dots, with a length limit of 1~128 characters. - **H5Url** (string) - Optional - Reserved field, H5 schemes are not supported yet. - **H5Origin** (string) - Optional - Reserved field, H5 schemes are not supported yet. ### Response #### Success Response (200) - **RequestId** (string) - The request ID. - **Message** (string) - Description of the status code. - **Model** (object) - The result of the operation. - **SchemeCode** (string) - The generated scheme code. - **Code** (string) - The status code. - **Success** (boolean) - Indicates if the request was successful. #### Response Example ```json { "RequestId": "B95B36EC-8108-4479-D3AA-2BB27F9B155A", "Message": "成功", "Model": { "SchemeCode": "FA100000168468035" }, "Code": "OK", "Success": false } ``` ``` -------------------------------- ### CreateSchemeConfig - Create Unified Authentication Scheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/CreateSchemeConfig Creates a unified authentication scheme, which identifies an authentication scenario within an App, typically corresponding to an App package name and signature. This API is used to create the scheme and obtain its scheme code. ```APIDOC ## POST CreateSchemeConfig ### Description Creates a unified authentication scheme used to identify an authentication scenario within an App, typically corresponding to an App package name and signature. This API is used to create the scheme and obtain its scheme code. ### Method POST ### Endpoint /CreateSchemeConfig ### Parameters #### Query Parameters - **SchemeName** (string) - Required - The name of the unified authentication scheme. - **SchemeType** (string) - Required - The type of the unified authentication scheme. For example, '1' for Android, '2' for iOS. - **AppPackageName** (string) - Required - The package name of the App. - **AppSignature** (string) - Required - The signature of the App. ### Request Example ```json { "SchemeName": "MyAuthScheme", "SchemeType": "1", "AppPackageName": "com.example.app", "AppSignature": "abcdef1234567890" } ``` ### Response #### Success Response (200) - **SchemeCode** (string) - The unique code generated for the unified authentication scheme. #### Response Example ```json { "SchemeCode": "SC1234567890ABCDEF" } ``` ``` -------------------------------- ### CreateSchemeConfig Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/overview Fusion authentication schemes are used to identify authentication scenarios under an App. Generally, one authentication scheme corresponds to one App package name and package signature. Call this interface to create a fusion authentication scheme and obtain the scheme code. ```APIDOC ## CreateSchemeConfig ### Description Creates a fusion authentication scheme and obtains its code. Schemes identify authentication scenarios for an App, typically linked to a package name and signature. ### Method POST (Assumed, as it's a creation operation) ### Endpoint /CreateSchemeConfig (Assumed based on title) ### Parameters #### Request Body - **appName** (string) - Required - The name of the application. - **packageName** (string) - Required - The package name of the application. - **packageSignature** (string) - Required - The package signature of the application. ### Request Example ```json { "appName": "com.example.app", "packageName": "com.example.app", "packageSignature": "abcdef123456..." } ``` ### Response #### Success Response (200) - **schemeCode** (string) - The code of the created authentication scheme. #### Response Example ```json { "schemeCode": "scheme_12345" } ``` ``` -------------------------------- ### VerifyWithFusionAuthToken Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25 When the client initiates authentication for fusion authentication, the developer's server uses the authentication token to call Alibaba Cloud to obtain the authentication result. ```APIDOC ## VerifyWithFusionAuthToken ### Description When the client initiates authentication for fusion authentication, the developer's server uses the authentication token to call Alibaba Cloud to obtain the authentication result. ### Method POST ### Endpoint /VerifyWithFusionAuthToken ### Parameters #### Query Parameters - **AuthToken** (string) - Required - The authentication token obtained from the developer's server. ### Request Example ```json { "AuthToken": "your_auth_token" } ``` ### Response #### Success Response (200) - **Result** (object) - The result of the fusion authentication. - **Code** (string) - The result code. - **Message** (string) - The result message. - **IsSuccessful** (boolean) - Indicates if the authentication was successful. #### Response Example ```json { "Result": { "Code": "OK", "Message": "Fusion authentication successful.", "IsSuccessful": true } } ``` ``` -------------------------------- ### GetMobile Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25 Obtains a phone number for server-side one-click login. After successfully obtaining the number, it is returned. ```APIDOC ## GetMobile ### Description This interface is used for server-side one-click login for number authentication. After successfully obtaining the number, it is returned. ### Method POST ### Endpoint /GetMobile ### Parameters #### Query Parameters - **VerifyToken** (string) - Required - The verification token. ### Request Example ```json { "VerifyToken": "your_verify_token" } ``` ### Response #### Success Response (200) - **Result** (object) - The result of obtaining the mobile number. - **Code** (string) - The result code. - **Message** (string) - The result message. - **PhoneNumber** (string) - The obtained phone number. #### Response Example ```json { "Result": { "Code": "OK", "Message": "Mobile number obtained successfully.", "PhoneNumber": "+1234567890" } } ``` ``` -------------------------------- ### DescribeVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25 Authentication scheme secret key and other parameter information will be used when calling other API interfaces. This interface is used to obtain the authentication scheme secret key information. ```APIDOC ## DescribeVerifyScheme ### Description Retrieves the secret key and other parameter information for an authentication scheme, which is required for calling other API interfaces. ### Method GET ### Endpoint /DescribeVerifyScheme ### Parameters #### Query Parameters - **schemeCode** (string) - Required - The code of the authentication scheme. ### Request Example ``` /DescribeVerifyScheme?schemeCode=scheme_12345 ``` ### Response #### Success Response (200) - **secretKey** (string) - The secret key of the authentication scheme. - **publicKey** (string) - The public key of the authentication scheme. #### Response Example ```json { "secretKey": "your_secret_key", "publicKey": "your_public_key" } ``` ``` -------------------------------- ### DescribeVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/overview When calling other API interfaces, parameters such as the authentication scheme key are used. This interface is used to obtain the authentication scheme key information. ```APIDOC ## DescribeVerifyScheme ### Description Retrieves authentication scheme key information, which is required for calling other API interfaces. ### Method GET (Assumed, as it's a retrieval operation) ### Endpoint /DescribeVerifyScheme (Assumed based on title) ### Parameters #### Query Parameters - **schemeCode** (string) - Required - The code of the authentication scheme. ### Request Example ``` GET /DescribeVerifyScheme?schemeCode=scheme_12345 ``` ### Response #### Success Response (200) - **schemeKey** (string) - The key information for the authentication scheme. #### Response Example ```json { "schemeKey": "a1b2c3d4e5f6..." } ``` ``` -------------------------------- ### QueryGateVerifyBillingPublic Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyBillingPublic This API retrieves billing information for GateVerify services, providing details on usage amounts and costs per scene. ```APIDOC ## QueryGateVerifyBillingPublic ### Description This API is used to query the billing information for each account and month for the Number Authentication service. It returns the total amount and a list of scene-specific billing details. ### Method POST (inferred from context, actual method not explicitly stated) ### Endpoint /QueryGateVerifyBillingPublic (inferred from context, actual endpoint not explicitly stated) ### Parameters #### Query Parameters - **ProdCode** (string) - Optional - This parameter was removed on 2022-01-13. ### Response #### Success Response (200) - **Code** (string) - Status code of the operation. Example: OK - **Message** (string) - Description of the status code. Example: successful - **RequestId** (string) - ID of the request. Example: 8906582E-6722 - **Data** (object) - Specific billing amounts and costs for each scene. - **AmountSum** (string) - Total billing amount. Example: 1234 - **SceneBillingList** (array) - List of billing details for each scene. - **Add** (string) - Additional usage count. Example: 74 - **SinglePrice** (string) - Price per unit. Example: 0.02 - **Amount** (string) - Calculated amount for the scene. Example: 1.48 - **ItemName** (string) - Name of the service item. Example: 本机号码校验 - **SceneCode** (string) - Code for the scene. Example: FC100000038194004 - **AppName** (string) - Name of the application. Example: 阿里云 - **SceneName** (string) - Name of the scene. Example: 阿里云通信 ### Response Example ```json { "Code": "OK", "Message": "successful", "RequestId": "8906582E-6722", "Data": { "AmountSum": "1234", "SceneBillingList": [ { "Add": "74", "SinglePrice": "0.02", "Amount": "1.48", "ItemName": "本机号码校验", "SceneCode": "FC100000038194004", "AppName": "阿里云", "SceneName": "阿里云通信" } ] } } ``` ``` -------------------------------- ### QueryGateVerifyBillingPublic Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/overview Call this interface to query the monthly billing for a certain authentication method. ```APIDOC ## QueryGateVerifyBillingPublic ### Description Queries the monthly billing details for a specific authentication method. ### Method GET (Assumed, as it's a query operation) ### Endpoint /QueryGateVerifyBillingPublic (Assumed based on title) ### Parameters #### Query Parameters - **month** (string) - Required - The month for which to query billing (e.g., YYYY-MM). - **verifyType** (string) - Optional - The type of verification to query billing for. ### Request Example ``` GET /QueryGateVerifyBillingPublic?month=2023-01&verifyType=SMS ``` ### Response #### Success Response (200) - **billingDetails** (object) - An object containing billing information. - **totalCost** (number) - The total cost for the month. - **currency** (string) - The currency of the cost. - **items** (array) - An array of billing items. - **description** (string) - Description of the billing item. - **cost** (number) - Cost of the item. #### Response Example ```json { "billingDetails": { "totalCost": 150.75, "currency": "CNY", "items": [ { "description": "SMS Authentication Usage", "cost": 120.50 }, { "description": "Other Charges", "cost": 30.25 } ] } } ``` ``` -------------------------------- ### GetPhoneWithToken Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetPhoneWithToken This interface is used for one-click login and phone number retrieval in H5 scenarios. After successfully obtaining the phone number, it will be returned. ```APIDOC ## GetPhoneWithToken - One-Click Login Number Retrieval (H5 Capability Only) ### Description This interface is used for one-click login and phone number retrieval in H5 scenarios. After successfully obtaining the phone number, it will be returned. ### Method POST ### Endpoint /getPhoneWithToken ### Parameters #### Query Parameters - **PhoneNumber** (string) - Required - The phone number obtained after successful authentication. - **Code** (string) - Required - The verification code returned by the SDK. - **Token** (string) - Required - The token returned by the SDK. - **OutId** (string) - Optional - A unique identifier for the request. ### Request Example ```json { "PhoneNumber": "13800138000", "Code": "123456", "Token": "some_token", "OutId": "unique_request_id" } ``` ### Response #### Success Response (200) - **GetPhoneNumberResult** (object) - The result of the phone number retrieval. - **Message** (string) - The status message. - **Code** (string) - The status code. - **LoginResult** (object) - The login result. - **PhoneNumber** (string) - The retrieved phone number. - **OutId** (string) - The unique identifier for the request. #### Response Example ```json { "GetPhoneNumberResult": { "Message": "OK", "Code": "OK", "LoginResult": { "PhoneNumber": "13800138000", "OutId": "unique_request_id" } } } ``` ### QPS Limit - The QPS limit for this interface is 500 times/second per user. ### Rate Limiting - Request rate is 50/1(s). ``` -------------------------------- ### GetFusionAuthToken Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/overview After the fusion authentication client is initialized, the developer server initiates a call to this interface to obtain an authentication token. The obtained authentication token is used to pass to the SDK for authentication. ```APIDOC ## GetFusionAuthToken ### Description Obtains an authentication token after the fusion authentication client is initialized. This token is used for SDK authentication. ### Method POST (Assumed, as it's an API call to get a token) ### Endpoint /GetFusionAuthToken (Assumed based on title) ### Parameters None explicitly mentioned in the provided text. ### Request Example None provided. ### Response #### Success Response (200) - **authToken** (string) - The obtained authentication token. #### Response Example None provided. ``` -------------------------------- ### DeleteVerifyScheme Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/overview If you no longer need a certain authentication scheme and need to delete it, call this interface or delete the authentication scheme in the Number Authentication Service console. ```APIDOC ## DeleteVerifyScheme ### Description Deletes an authentication scheme. This can be called if an authentication scheme is no longer needed. ### Method DELETE (Assumed, as it's a deletion operation) ### Endpoint /DeleteVerifyScheme (Assumed based on title) ### Parameters #### Query Parameters - **schemeCode** (string) - Required - The code of the authentication scheme to delete. ### Request Example ``` DELETE /DeleteVerifyScheme?schemeCode=scheme_12345 ``` ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the scheme was deleted. #### Response Example ```json { "message": "Authentication scheme deleted successfully." } ``` ``` -------------------------------- ### VerifyPhoneWithToken Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25 Performs an H5 page mobile number verification and returns the authentication result. ```APIDOC ## VerifyPhoneWithToken ### Description Calls this interface for H5 page mobile number verification. After authentication, it returns the authentication result. ### Method POST ### Endpoint /VerifyPhoneWithToken ### Parameters #### Query Parameters - **PhoneNumber** (string) - Required - The phone number to verify. - **Token** (string) - Required - The token for H5 verification. ### Request Example ```json { "PhoneNumber": "+1234567890", "Token": "your_h5_token" } ``` ### Response #### Success Response (200) - **Result** (object) - The result of the H5 mobile number verification. - **Code** (string) - The result code. - **Message** (string) - The result message. - **IsSuccessful** (boolean) - Indicates if the verification was successful. #### Response Example ```json { "Result": { "Code": "OK", "Message": "H5 verification successful.", "IsSuccessful": true } } ``` ``` -------------------------------- ### GetAuthToken Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetAuthToken Obtains an H5 authentication token for phone number verification. The response includes an AccessToken and a JwtToken. ```APIDOC ## GetAuthToken ### Description Obtains an H5 authentication token for phone number verification. The response includes an AccessToken and a JwtToken. ### Method POST ### Endpoint /api/getAuthToken ### Parameters #### Query Parameters - **PhoneNumber** (string) - Required - The phone number to verify. - **SessionId** (string) - Required - The session ID for the verification. - **OutId** (string) - Optional - A unique identifier for the request. ### Request Example { "PhoneNumber": "13800138000", "SessionId": "your_session_id", "OutId": "your_out_id" } ### Response #### Success Response (200) - **AccessToken** (string) - The authentication access token. - **JwtToken** (string) - The JSON Web Token for authentication. - **Code** (string) - The response code. - **Message** (string) - The response message. #### Response Example { "AccessToken": "your_access_token", "JwtToken": "your_jwt_token", "Code": "OK", "Message": "Success" } ``` -------------------------------- ### GetAuthToken API Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/GetAuthToken This API retrieves an authorization token required for H5 native number verification authentication. ```APIDOC ## GetAuthToken ### Description Retrieves an authorization token for H5 native number verification authentication. ### Method POST (inferred from context, not explicitly stated) ### Endpoint /GetAuthToken (inferred from file name and context) ### Parameters #### Request Body - **PageUrl** (string) - Required - The URL of the page, as configured in the console when creating an authentication scheme. Format: "protocol + // + domain + /" - **Origin** (string) - Required - The source address, as configured in the console when creating an authentication scheme. Format: "protocol + // + domain" - **SceneCode** (string) - Required - The scheme code. - **BizType** (integer) - Optional - Business type. - **CmApiCode** (integer) - Optional - **CuApiCode** (integer) - Optional - **CtApiCode** (integer) - Optional ### Response #### Success Response (200) - **Code** (string) - Status code. Example: OK - **Message** (string) - Description of the status code. Example: Request successful - **RequestId** (string) - Request ID. Example: 8906582E-6722 - **TokenInfo** (object) - Structure containing token details. - **AccessToken** (string) - The access token. - **JwtToken** (string) - The JWT token. ### Request Example ```json { "PageUrl": "https://www.aliyundoc.com/", "Origin": "https://www.aliyundoc.com", "SceneCode": "FC10000010643****" } ``` ### Response Example ```json { "Code": "OK", "Message": "请求成功", "RequestId": "8906582E-6722", "TokenInfo": { "AccessToken": "agag****", "JwtToken": "aweghd****" } } ``` ``` -------------------------------- ### QueryGateVerifyStatisticPublic Source: https://next.api.aliyun.com/document/Dypnsapi/2017-05-25/QueryGateVerifyStatisticPublic Retrieves the total calls, successful calls, failed calls, and unknown calls for a specific verification method within a given date range. It also provides daily usage statistics. ```APIDOC ## QueryGateVerifyStatisticPublic - 查询用量情况 ### Description This API allows you to query the total calls, successful calls, failed calls, and unknown calls for a specific verification method within a specified date range. It also provides daily usage statistics. ### Method GET ### Endpoint /QueryGateVerifyStatisticPublic ### Parameters #### Query Parameters - **StartTime** (string) - Required - The start date for the query. - **EndTime** (string) - Required - The end date for the query. - **VerificationType** (string) - Required - The type of verification to query statistics for. ### Request Example (No request body is typically sent for a GET request of this nature, parameters are usually query parameters.) ### Response #### Success Response (200) - **TotalCalls** (integer) - The total number of calls. - **SuccessfulCalls** (integer) - The number of successful calls. - **FailedCalls** (integer) - The number of failed calls. - **UnknownCalls** (integer) - The number of unknown calls. - **DailyStatistics** (array) - An array of daily usage statistics. - **Date** (string) - The date of the statistics. - **Calls** (integer) - The number of calls for that date. #### Response Example ```json { "TotalCalls": 1000, "SuccessfulCalls": 950, "FailedCalls": 40, "UnknownCalls": 10, "DailyStatistics": [ { "Date": "2026-03-19", "Calls": 500 }, { "Date": "2026-03-20", "Calls": 500 } ] } ``` ### QPS Limit This interface has a single-user QPS limit of 500 requests per second. Exceeding this limit may result in API calls being throttled. ```