[Mobile Synthetic Testing] Terms of Use Status¶
GET /api/v1/dialing_task/mobile/terms
Overview¶
Query the workspace acceptance status for the Mobile Synthetic Testing terms of use.
Before Calling and Usage Steps¶
An OpenAPI identity is allowed to query; accepted indicates a valid server-side acceptance record, not a platform switch state. canAccept is always false for API Keys. When there is no valid record, accepted=false/acceptance=null; legacy generic configurations or duplicate/corrupted records are not treated as acceptance.
This request does not accept the terms, create a task, or initialize the mobile platform; it is not directly blocked by the Mobile Synthetic Testing toggle being disabled. After logging in to the product, the Workspace Owner/Administrator must read and accept the terms, and then query accepted=true. Granting an administrator role to a Key must not be treated as the acceptance action of a logged-in user.
Request Headers¶
| Parameter | Type | Required | Description |
|---|---|---|---|
| DF-API-KEY | string | Y | OpenAPI authentication credential for the workspace. Example: <DF-API-KEY>How to obtain or enter: Obtain an OpenAPI Key with this operation permission from API Key Management in the target workspace. |
Additional Parameter Notes¶
The workspace is obtained from the authentication context. Only accepted/canAccept/acceptance are returned; if not accepted, acceptance=null, and the acceptance record contains only acceptedBy and the server-side Unix timestamp acceptedAt in seconds. An API Key can query only its own workspace and cannot accept; there is no terms URL, language, or product version configuration.
Request Example¶
curl --get 'https://openapi.guance.com/api/v1/dialing_task/mobile/terms' \
-H 'DF-API-KEY: <DF-API-KEY>'
Response¶
HTTP 200 JSON; this route explicitly skips declaration, and content does not contain this field.
| Field | Type | Description |
|---|---|---|
| content.accepted | boolean | Whether a valid server-verified acceptance exists for the current workspace. |
| content.canAccept | boolean | Whether the current identity can accept; for an OpenAPI identity this is fixed to false, and a logged-in member identity cannot be forged based on the API Key role. |
| content.acceptance | object or null | Acceptance record; null when not accepted or when the historical record is duplicate/corrupted. |
| content.acceptance.acceptedBy | string | acnt_ UUID of the logged-in member who actually accepted, not this API Key. |
| content.acceptance.acceptedAt | integer | Server-side Unix timestamp in seconds when accepted. |
{
"code": 200,
"content": {
"accepted": false,
"canAccept": false,
"acceptance": null
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
Error Response¶
For authentication, rate limiting, and common request errors, see Common Error Definitions.
| HTTP Status | errorCode | Trigger Condition | Message or Response Description | Resolution |
|---|---|---|---|---|
| 403 | ft.Forbidden | The current calling identity is not allowed to query the terms (a normal OpenAPI identity satisfies this) | You do not have permission to perform this operation | Use a valid OpenAPI Key for the target workspace; do not use other shared or non-member credentials. |
| 401 | ft.WKSPNotExistOrReleased | The current workspace does not exist or has been released | Workspace does not exist or has been released | Verify that the workspace is valid. |
| 500 | ft.InternalServerError | Exception in storage read, historical configuration, or local static mapping formatting | Internal error | Narrow it down to a specific task/template or filter; if it persists, retain traceId to check the read stage. |