Media API - Mrdaigithub/crm GitHub Wiki

Media API

功能描述:

  • 获取渠道来源列表

请求URL:

  • http://xx.com/api/v1/media/

请求方式:

  • GET

参数:

参数名 必选 类型 说明
token String 当前用户token

返回示例

{
  "media_list": [
    {
      "id": "1",
      "name": "baidu",
      "state": "0"
    },
    {
      "id": "2",
      "name": "google",
      "state": "0"
    },
    {
      "id": "3",
      "name": "360",
      "state": "0"
    },
    {
      "id": "4",
      "name": "sougou",
      "state": "0"
    }
  ]
}

返回参数说明

参数名 类型 说明
media_list Array 渠道来源列表

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足

功能描述:

  • 创建渠道来源

请求URL:

  • http://xx.com/api/v1/media/

请求方式:

  • POST

参数:

参数名 必选 类型 说明
token String 当前用户token
media_name String 渠道来源名称
state Boolean 渠道来源的启用状态

返回示例

{
  "new_media": {
    "id": "9",
    "media_name": "bing",
    "state": "0"
  }
}

返回参数说明

参数名 类型 说明
new_media Object 新增的渠道来源信息

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46003 渠道来源名称重复

功能描述:

  • 删除指定渠道来源

请求URL:

  • http://xx.com/api/v1/media/ID

请求方式:

  • DELETE

参数:

参数名 必选 类型 说明
token String 当前用户token

返回示例

返回参数说明

参数名 类型 说明

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足

功能描述:

  • 更新指定渠道来源名称

请求URL:

  • http://xx.com/api/v1/media/name/ID

请求方式:

  • PATCH

参数:

参数名 必选 类型 说明
token String 当前用户token
media_name String 渠道来源的新名称

返回示例

{
  "new_media": {
    "id": "11",
    "media_name": "bing",
    "state": "0"
  }
}

返回参数说明

参数名 类型 说明
new_media Object 修改名称后的渠道来源

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46004 要操作的渠道来源不存在
46003 渠道来源名称重复

功能描述:

  • 更新指定渠道来源启用状态

请求URL:

  • http://xx.com/api/v1/media/state/ID

请求方式:

  • PATCH

参数:

参数名 必选 类型 说明
token String 当前用户token
media_name String 渠道来源的新启用状态

返回示例

{
  "new_media": {
    "id": "11",
    "media_name": "bing",
    "state": "1"
  }
}

返回参数说明

参数名 类型 说明
new_media Object 修改名称后的渠道来源

错误状态码

参数名 说明
40010 缺少token参数
40014 无效的token
42001 token参数过期
48001 权限不足
44001 参数缺失
46004 要操作的渠道来源不存在