Skip to content

协议配置

协议配置接口调用过程中,根据配置返回不同结果。正常调用成功会返回协议配置信息,没有配置协议,返回空数组。

请求说明

请求头

参数名中文名称必须类型描述
X-operating-sys-version调用方客户端操作系统版本Stringwindows10.1.1
X-device-fingerprint调用方客户端设备指纹String156aysdna213sc50
X-device-ip调用方客户端IPString192.168.1.2
X-agentUser-Agent信息StringMozilla/5.0 (iPhone; CPU iPhone OS 13_3 like Mac OS X)
X-L用于国际化语言设置Stringzh
X-client-id应用授权IDStringnTo1eRIub60vPb54WeE6aojPwYwImtl4
content-type内容格式类型Stringapplication/json

返回示例

成功示例

HTTP/1.1 200 OK

json
{
    "code": "0",
    "data": [
        {
            "id": "20231213172230071-656B-DC5398451",
            "text": {
                "en": {
                    "context": "I have read and agree to the {20231214153403735-0EB3-72CE8BDC0} and {20231214153403729-2452-986A407AA}",
                    "agreements": [
                        {
                            "id": "20231214153403735-0EB3-72CE8BDC0",
                            "name": "23",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403729-2452-986A407AA",
                            "name": "12",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                },
                "zh": {
                    "context": "我已阅读并同意{20231214153403717-76A1-31234B44F}和{20231214153403713-DA60-2201131A6}",
                    "agreements": [
                        {
                            "id": "20231214153403717-76A1-31234B44F",
                            "name": "2",
                            "type": "URL",
                            "context": "https://XXX"
                        },
                        {
                            "id": "20231214153403713-DA60-2201131A6",
                            "name": "1",
                            "type": "URL",
                            "context": "https://XXX"
                        }
                    ]
                }
            }
        }
    ],
    "message": null
}

错误示例

json

返回参数

data为协议配置列表,列表参数内容:

参数名中文名称类型
id协议配置idString
text协议配置中协议正文Object
text.context协议正文中内容String
text.agreements协议正文中协议Object
text.agreements.id协议idString
text.agreements.name协议名称String
text.agreements.type协议类型String
text.agreements.context协议类型对应内容String

错误码

状态码错误码错误信息处理措施
400IDAAS.SDK.PARAM.0001Device information is incomplete请检查输入的设备信息是否完整
设备信息不完整

竹云IDaaS开放平台