[Mobile Synthetic Test] Accept Terms of Use¶
POST /api/v1/dialing_task/mobile/terms/accept
Overview¶
Reserved terms acceptance endpoint; an OpenAPI Key cannot replace member confirmation.
Before Calling and Usage Steps¶
This public path remains available, but the controller only allows a real Front logged-in Workspace Owner/administrator to confirm. Therefore, a normal call using DF-API-KEY returns 403 ft.MobileDialTermsAcceptForbidden, and there is no parameter combination by which a Key can successfully confirm. Have an eligible member read and accept the terms in the product, then use Check Confirmation Status for verification.
The request example uses {}; you cannot provide acceptedBy/acceptedAt to forge records. This OpenAPI branch terminates at the permission check and does not create a confirmation record or success audit. The shared Front implementation can idempotently confirm and generate server-side time/identity; this does not mean the current Key endpoint supports this behavior.
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 the required permission from API Key Management in the target Workspace. |
Additional Parameter Notes¶
Only a logged-in Workspace Owner or administrator can confirm; API Keys are prohibited. Only an empty request {} is accepted; version, person, time, or Workspace fields are not accepted. For repeated successes, the first person and the server Unix timestamp in seconds (acceptedAt) are retained.
Request Example¶
curl --request POST 'https://openapi.guance.com/api/v1/dialing_task/mobile/terms/accept' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{}'
Response¶
A normal OpenAPI call returns an HTTP 403 JSON error; the actual rejection structure is shown below. It does not state that a Key call can successfully confirm.
| Field | Type | Description |
|---|---|---|
| content | object | Empty error content when OpenAPI normally rejects; this route skips declaration. |
{
"code": 403,
"content": {},
"errorCode": "ft.MobileDialTermsAcceptForbidden",
"message": "Only a logged-in Workspace Owner or administrator can accept the Mobile Synthetic Test Terms of Use.",
"success": false,
"traceId": "TRACE-EXAMPLE"
}
Error Responses¶
For authentication, rate limiting, and common request errors, see Common Error Definitions.
| HTTP Status | errorCode | Trigger Condition | Message or Response Description | Handling |
|---|---|---|---|---|
| 400 | ft.RequestJsonFormatError | Invalid request JSON syntax | Request JSON format error | Fix the JSON according to content.reason, line, and column. |
| 400 | ft.JsonFormatError | The body top level is not a JSON object; fails before the confirmation permission check | Partial JSON file format error | Submit {} as shown in the example; a valid object still does not grant a Key the confirmation permission. |
| 403 | ft.MobileDialTermsAcceptForbidden | The OpenAPI identity is not an eligible Front logged-in member | Only a logged-in Workspace Owner or administrator can accept the Mobile Synthetic Test Terms of Use. | Log in to the product and have the Workspace Owner/administrator read and accept; do not impersonate a member via API Key. |