获取背景的集合 - 一知开放平台

请求参数

Query 参数

name

string

背景名称模糊查询

可选

Header 参数

authorization

string

必需

所有接口都需 MD5(APP_ID+APP_SECRET+timestamp) 32位小写 APP_SECRET需要我们提供

示例值:

req_from

string

必需

直销客户传C ，代理商传D

示例值:

C

timestamp

integer

时间戳

必需

示例值:

app_id

string

必需

APPID，开启后获得

示例值:

account

string

可选

代理商的客户账号，直销客户不传，代理商必传

示例值:

19999999999

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET '/openApiDigitalPerson/liveProcess/getBackgroundList?name=' \
--header 'authorization: {{auth|md5}}' \
--header 'req_from: C' \
--header 'timestamp: {{timestamp}}' \
--header 'app_id: {{appId}}' \
--header 'account: 19999999999'

返回响应

🟢200成功

application/json

Body

code

integer

可选

错误代码，200表示执行成功

默认值:

CommonErrorCode.SUCCESS.getCode()

data

array[object (LiveBackgroundResultDTO) {5}]

返回的数据

可选

backgroundId

integer

自增主键

可选

name

string

背景图名称

可选

recentUsageTime

integer

素材最近使用的时间

可选

url

string

背景图片URL

可选

isBuilt

integer

可选

是否是内置的背景 0为否 1为是

requestId

string

请求唯一标记

可选

resultMsg

string

提示信息

可选

默认值:

CommonErrorCode.SUCCESS.getDesc()

host

string

业务主机名

可选

默认值:

getHostName()

errorStackTrace

string

异常堆栈

可选

示例

{
  "code": 0,
  "data": [
    {
      "backgroundId": 0,
      "name": "",
      "recentUsageTime": 0,
      "url": "",
      "isBuilt": 0
    }
  ],
  "requestId": "",
  "resultMsg": "",
  "host": "",
  "errorStackTrace": ""
}