Draftbox API

订阅号/服务号通用

方法

draftAdd()

新建草稿。 文档: 查看官方文档

签名

draftAdd(payload)

参数

参数	类型	必填	默认值	说明
payload	{articles:Array<Object>}	是		- 图文数组 articles

返回值

类型：Promise<{media_id:string}>

示例

// 用法示例
await client.draftAdd(payload);

draftBatchGet()

批量获取草稿。 文档: 查看官方文档

签名

draftBatchGet(params)

参数

参数	类型	必填	默认值	说明
params	{offset:number, count:number, no_content?:0|1}	是

返回值

类型：Promise<{total_count:number, item_count:number, item:Array<Object>}>

示例

// 用法示例
await client.draftBatchGet(params);

draftCount()

获取草稿总数。 文档: 查看官方文档

签名

draftCount()

返回值

类型：Promise<{total_count:number}>

示例

// 用法示例
await client.draftCount();

draftDelete()

删除草稿。 文档: 查看官方文档

签名

draftDelete(params)

参数

参数	类型	必填	默认值	说明
params	{media_id:string}	是

返回值

类型：Promise<{errcode:number, errmsg:string}>

示例

// 用法示例
await client.draftDelete(params);

draftSwitch()

草稿箱开关。 文档: 查看官方文档

签名

draftSwitch(params)

参数

参数	类型	必填	默认值	说明
params	{is_open:0|1}	是		- 1 开启，0 关闭

返回值

类型：Promise<{errcode:number, errmsg:string}>

示例

// 用法示例
await client.draftSwitch(params);

draftUpdate()

修改草稿。 文档: 查看官方文档

签名

draftUpdate(payload)

参数

参数	类型	必填	默认值	说明
payload	Object	是		- 按文档传入 {media_id, index?, articles}

返回值

类型：Promise<{errcode:number, errmsg:string}>

示例

// 用法示例
await client.draftUpdate(payload);

ecsGetProductCardInfo()

获取商品卡片信息。 文档: 查看官方文档

签名

ecsGetProductCardInfo(params)

参数

参数	类型	必填	默认值	说明
params	Object	是		- 按文档传入查询条件（如商品 ID 等）

返回值

类型：Promise<Object>

示例

// 用法示例
await client.ecsGetProductCardInfo(params);

getDraft()

获取草稿。 文档: 查看官方文档

签名

getDraft(params)

参数

参数	类型	必填	默认值	说明
params	{media_id:string}	是

返回值

类型：Promise<Object>

示例

// 用法示例
await client.getDraft(params);