短信服务使用方可以调用GetTobTrafficDrivingLinkList接口查询引流链接。

请求说明

• 请求方式：GET
• 接口地址：https://sms.volcengineapi.com/?Action=GetTobTrafficDrivingLinkList&Version=2021-01-11

请求参数

Query

const columns = [
  {
    width: '9%',
    title: '名称',
    dataIndex: 'Name',
  },
  {
    width: '9%',
    title: '类型',
    dataIndex: 'DataType',
  },
  {
    width: '9%',
    title: '是否必填',
    dataIndex: 'IsRequired',
  },
  {
    width: '18%',
    title: '示例值',
    dataIndex: 'Example',
  },
  {
    width: '55%',
    title: '描述',
    dataIndex: 'Description',
  },
];


const data = [
  {
    rowKey: '->Action',
    Name: 'Action',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"GetTobTrafficDrivingLinkList"} />,
    Description: <RenderMd content={"要执行的操作，取值：GetTobTrafficDrivingLinkList"} />,
    children: [
    ]
  },
  {
    rowKey: '->Version',
    Name: 'Version',
    DataType: 'String',
    IsRequired: '是',
    Example: <RenderMd content={"2021-01-11"} />,
    Description: <RenderMd content={"API的版本，取值：2021-01-11"} />,
    children: [
    ]
  },
  {
    rowKey: '->link',
    Name: 'link',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"http://test.com"} />,
    Description: <RenderMd content={"文案链接，模糊搜索"} />,
    children: [
    ]
  },
  {
    rowKey: '->jumpLink',
    Name: 'jumpLink',
    DataType: 'String',
    IsRequired: '否',
    Example: <RenderMd content={"http://test.com"} />,
    Description: <RenderMd content={"跳转链接，模糊搜索"} />,
    children: [
    ]
  },
];

return (<Table
  rowKey="rowKey"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);

响应数据

const columns = [
  {
    title: '名称',
    dataIndex: 'Name',
    width: '10%',
  },
  {
    title: '类型',
    dataIndex: 'DataType',
    width: '10%',
  },
  {
    title: '示例值',
    dataIndex: 'Example',
    width: '20%',
  },
  {
    title: '描述',
    dataIndex: 'Description',
    width: '60%',
  },
];

const data = [
  {
    rowKey: "->ResponseMetadata",
    Name: "ResponseMetadata",
    DataType: "ResponseMetadata",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={"响应公共参数。"} />,
    children: [
        {
          rowKey: "->ResponseMetadata->RequestId",
          Name: "RequestId",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"请求ID"} />,
          children: [
          ]
        },
        {
          rowKey: "->ResponseMetadata->Action",
          Name: "Action",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"请求方法"} />,
          children: [
          ]
        },
        {
          rowKey: "->ResponseMetadata->Version",
          Name: "Version",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"请求API版本"} />,
          children: [
          ]
        },
        {
          rowKey: "->ResponseMetadata->Service",
          Name: "Service",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"Service"} />,
          children: [
          ]
        },
        {
          rowKey: "->ResponseMetadata->Region",
          Name: "Region",
          DataType: "String",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"Region"} />,
          children: [
          ]
        },
        {
          rowKey: "->ResponseMetadata->Error",
          Name: "Error",
          DataType: "Error",
          Example: <RenderMd content={""} />,
          Description: <RenderMd content={"错误信息"} />,
          children: [
            {
              rowKey: "->ResponseMetadata->Error->Code",
              Name: "Code",
              DataType: 'String',
              Example: <RenderMd content={""} />,
              Description: <RenderMd content={"错误码"} />,
              children: [
              ]
            },
            {
              rowKey: "->ResponseMetadata->Error->Message",
              Name: "Message",
              DataType: 'String',
              Example: <RenderMd content={""} />,
              Description: <RenderMd content={"错误描述"} />,
              children: [
              ]
            },
          ]
        },
    ]
  },
  {
    rowKey: "->Result",
    Name: "Result",
    DataType: "Result",
    Example: <RenderMd content={" "} />,
    Description: <RenderMd content={""} />,
    children: [
    	{
              rowKey: "->Result->list",
              Name: "list",
              DataType: "array of json",
              Example: <RenderMd content={""} />,
              Description: <RenderMd content={"引流链接数据"} />,
              children: [
              	{
                      rowKey: "->Result->list->account",
                      Name: "account",
                      DataType: "String",
                      Example: <RenderMd content={"xxx"} />,
                      Description: <RenderMd content={"账号ID"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->useVolcLink",
                      Name: "useVolcLink",
                      DataType: "Bool",
                      Example: <RenderMd content={"false"} />,
                      Description: <RenderMd content={"是否使用火山短链"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->protocol",
                      Name: "protocol",
                      DataType: "String",
                      Example: <RenderMd content={"https"} />,
                      Description: <RenderMd content={"文案链接协议"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->link",
                      Name: "link",
                      DataType: "String",
                      Example: <RenderMd content={"https://test.com/path"} />,
                      Description: <RenderMd content={"文案链接"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->linkDomainIcp",
                      Name: "linkDomainIcp",
                      DataType: "String",
                      Example: <RenderMd content={"test-icp"} />,
                      Description: <RenderMd content={"文案链接域名备案号"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->linkDomainIcpBody",
                      Name: "linkDomainIcpBody",
                      DataType: "String",
                      Example: <RenderMd content={"test-icpBody"} />,
                      Description: <RenderMd content={"文案链接域名备案主体"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->linkDomain",
                      Name: "linkDomain",
                      DataType: "String",
                      Example: <RenderMd content={"test.com"} />,
                      Description: <RenderMd content={"文案链接二级域名"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->linkPath",
                      Name: "linkPath",
                      DataType: "String",
                      Example: <RenderMd content={"/path"} />,
                      Description: <RenderMd content={"文案链接path"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->jumpLink",
                      Name: "jumpLink",
                      DataType: "String",
                      Example: <RenderMd content={"https://test.com/path"} />,
                      Description: <RenderMd content={"跳转链接"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->jumpLinkDomain",
                      Name: "jumpLinkDomain",
                      DataType: "String",
                      Example: <RenderMd content={"test.com"} />,
                      Description: <RenderMd content={"跳转链接二级域名"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->jumpLinkPath",
                      Name: "jumpLinkPath",
                      DataType: "String",
                      Example: <RenderMd content={"/path"} />,
                      Description: <RenderMd content={"跳转链接path"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->jumpLinkDomainIcp",
                      Name: "jumpLinkDomainIcp",
                      DataType: "String",
                      Example: <RenderMd content={"test-icp"} />,
                      Description: <RenderMd content={"跳转链接域名备案号"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->jumpLinkDomainIcpBody",
                      Name: "jumpLinkDomainIcpBody",
                      DataType: "String",
                      Example: <RenderMd content={"test-icpBody"} />,
                      Description: <RenderMd content={"跳转链接域名备案主体"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->createdAt",
                      Name: "createdAt",
                      DataType: "int",
                      Example: <RenderMd content={"1755593987"} />,
                      Description: <RenderMd content={"创建时间秒级时间戳"} />,
                      children: [
                      ]
                },
                {
                      rowKey: "->Result->list->updatedAt",
                      Name: "updatedAt",
                      DataType: "int",
                      Example: <RenderMd content={"1755593987"} />,
                      Description: <RenderMd content={"更新时间秒级时间戳"} />,
                      children: [
                      ]
                },          
              ]
	    },
	    {
              rowKey: "->Result->total",
              Name: "total",
              DataType: "int",
              Example: <RenderMd content={"1"} />,
              Description: <RenderMd content={"引流链接总数"} />,
              children: [
              ]
	    },
    ]
  },
];

return (<Table
  rowKey="rowKey"
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);

示例

成功请求示例

请求

{
    link: "https://test-xxx.com/demo"
}

响应

{
    "ResponseMetadata": {
        "RequestId": "2022090818181501017423503804EC****",
        "Action": "GetTobTrafficDrivingLinkList",
        "Version":"2021-01-11",
        "Service":"volcSMS",
        "Region":"cn-north-1"
    },
    "Result": {
        "list": [
            {
                "account": "test-account",
                "useVolcLink": false,
                "protocol": "https",
                "link": "https://test.com/path",
                "linkDomainIcp": "test-icp",
                "linkDomainIcpBody": "test-icpBody",
                "linkDomain": "test.com",
                "linkPath": "/path",
                "jumpLink": "https://test.com/path",
                "jumpLinkDomain": "test.com",
                "jumpLinkPath": "/path",
                "jumpLinkDomainIcp": "test-icp",
                "jumpLinkDomainIcpBody": "test-icpBody",
                "createdAt": 1755593987,
                "updatedAt": 1755593987
            }
        ],
        "total": 1
    }
}

错误码

下表提供了该接口业务逻辑相关的错误码。公共错误码请参见公共错误码。

const columns = [
  {
    title: 'HttpCode',
    dataIndex: 'HttpCode',
    width: '9%',
  },
  {
    title: '错误码',
    dataIndex: 'ErrorCode',
    width: '13%',
  },
  {
    title: '错误信息',
    dataIndex: 'ErrorMessage',
    width: '39%',
  },
  {
    title: '描述',
    dataIndex: 'Description',
    width: '39%',
  },
];
    
const data = [
  { 
    HttpCode: 200,
    ErrorCode: '1001',
    ErrorMessage: '参数错误',
    Description: <RenderMd content={"参数错误"} />,
  },
  { 
    HttpCode: 200,
    ErrorCode: '1999',
    ErrorMessage: '系统错误',
    Description: <RenderMd content={"系统错误"} />,
  },
];

return (<Table
  columns={columns}
  data={data}
  border={ { cell: true, wrapper: true } }
  pagination={false}
/>);