查询签名信息
更新时间：2023-08-03
1.功能说明
1.1.该接口可以查询自己账户下创建的所有签名，实现和自己业务系统无缝对接。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址：http(s)://api.guoyangyun.com/api/smssign/search.htm
1.4.汉字字符集：UTF-8，请注意参数的大小写。
1.2.建议采用Post方法提交请求。
1.3.接口调用地址：http(s)://api.guoyangyun.com/api/smssign/search.htm
1.4.汉字字符集：UTF-8，请注意参数的大小写。
2.输入参数
| 参数 | 名称 | 类型 | 必须 | 描述 |
| 公共参数 | 公共参数 | — | 是 | 详见《公共参数和配置》文档 |
| smsSignCode | 签名ID | String | 否 | 要查询的签名ID。 |
| signName | 签名名称 | String | 否 | 要查询的签名名称。 |
| pageSize | 分页大小 | Int | 否 | 可自定义查询页大小，默认值50条/页。 |
| page | 查询页 | Int | 否 | 可指定查询页，默认值第1页。 |
3.调用示例
http(s)://api.guoyangyun.com/api/smssign/search.htm?appkey=您的appkey&appsecret=您的appsecret&smsSignCode=签名ID&signName=签名名称&page=查询页&pageSize=分页大小
特别提醒：需对url中的参数进行URLEncode编码，以免出现参数异常查询不准确情况。
4.Json返回
4.1.返回参数
| 参数 | 名称 | 类型 | 描述 |
| code | 返回码 | Int | 请求返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》） |
| msg | 信息提示内容 | String | 返回成功/错误详细描述信息。 |
 list |
签名列表 | List | 返回签名创建详细信息 |
| created | 创建时间 | String | 签名的创建时间 |
| modified | 修改时间 | String | 签名最近一次修改时间 |
| primaryName | 主账户名 | String | 主账户的登录名称 |
| username | 账户名称 | String | 账户登录名称 |
| code | 签名ID | String | 签名ID（对应发送接口参数：smsSignId） |
| signName | 签名名称 | String | 签名名称（短信前缀名称） |
| status | 签名状态 | Int | 状态说明： 1：正常； 2：禁用； 3：等待审核； 4：审核拒绝 |
| reason | 说明 | String | 签名相关说明（如：审核说明、禁用说明等） |
| usageType | 签名用途 | Int | 签名用途，详见签名添加接口请求参数说明。 |
| sceneType | 签名来源 | Int | 签名来源，详见签名添加接口请求参数说明。 |
| sceneDomain | 来源说明 | String | 签名来源证明资料，详见签名添加接口请求参数说明。 |
| sceneRemark | 使用场景 | String | 签名的使用场景描述 |
4.2.调用成功样例
{
"msg":"成功",
"code":"0",
"list":[
{
"created":"2023-08-02 14:25:55", //模板创建时间
"modified":"2023-08-02 14:25:55", //模板修改时间
"primaryName":"a123456", //主账户名
"username":"a123456", //账户名
"signName":"abc", //签名名称
"status":1, //签名状态
"code":"83711fa89c6343a2b", //签名ID
"reason":null, //审核说明
"usageType":1, //签名用途
"sceneType":1, //签名来源
"sceneDomain":null, //来源说明
"sceneRemark":null //使用场景说明
},
{
"created":"2023-08-02 14:42:23",
"modified":"2023-08-02 15:07:51",
"primaryName":"a123456",
"username":"web13588088220",
"signName":"测试1",
"status":1,
"code":"bc8e4a2a4c4d4d6e9",
"reason":null,
"usageType":2,
"sceneType":2,
"sceneDomain":"来源测试aaa",
"sceneRemark":"场景测试aaa"
}
]
}
4.3.调用失败样例
{
"code":"XXXX",
"msg":"错误提示内容"
}