调用GetSmsConfig获取短信配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetSmsConfig |
系统规定参数。取值:GetSmsConfig。 |
InstanceId | String | 是 | 9cfad875-6260-4a53-ab6e-b13e3fb31f7d |
实例ID |
Scenario.N | RepeatList | 是 | 2 |
场景,1:短信满意度;2:IVR流程中使用;3:漏话短信。 参数名称Scenario.1表示只获取1个场景下的短信配置信息,如果要获取多个场景的短信配置信息,则需要有Scenario.1以及Scenario.2,以此类推,请参考下方的请求示例。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Code | String | OK |
响应码 |
HttpStatusCode | Integer | 200 |
HTTP状态码 |
Message | String | 无 |
响应信息 |
RequestId | String | E993D7CD-D546-4F88-9B04-62DFB05ED7E1 |
请求ID |
SmsConfigs | Array of SmsConfig |
配置列表,没有则不返回。 |
|
SmsConfig | |||
Description | String | 验证码${code},您正在进行身份验证,打死不要告诉别人哦! |
短信模板内容 |
Extra | String | 无 |
额外参数,与具体场景有关 |
GmtCreate | String | 无 | |
GmtModified | String | 无 | |
Id | Long | 36230 | |
Instance | String | 无 | |
Name | String | 身份验证 |
名称 |
Scenario | Integer | 2 |
场景 |
SignName | String | 阿里大于测试专用 |
短信签名名称 |
TemplateCode | String | SMS_96955021 |
短信模板CODE |
Success | Boolean | true |
是否成功 |
示例
请求示例
http(s)://ccc.cn-shanghai.aliyuncs.com/?Action=GetSmsConfig
&InstanceId=9cfad875-6260-4a53-ab6e-b13e3fb31f7d
&Scenario.1=2
&Scenario.2=3
&<公共请求参数>
正常返回示例
XML
格式
<GetSmsConfigResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>E993D7CD-D546-4F88-9B04-62DFB05ED7E1</RequestId>
<Success>true</Success>
<Code>OK</Code>
<SmsConfigs>
<SmsConfig>
<Name>身份验证</Name>
<Description>验证码${code},您正在进行身份验证,打死不要告诉别人哦!</Description>
<Scenario>2</Scenario>
<SignName>阿里大于测试专用</SignName>
<Id>24</Id>
<TemplateCode>SMS_95905021</TemplateCode>
</SmsConfig>
<SmsConfig>
<Name>漏话短信</Name>
<Description>你好,刚刚我司员工向您致电,但由于某些原因您未能接听,我们会尽快再次给您致电。</Description>
<Scenario>3</Scenario>
<SignName>云呼叫中心</SignName>
<Id>25</Id>
<TemplateCode>SMS_142385986</TemplateCode>
</SmsConfig>
</SmsConfigs>
</GetSmsConfigResponse>
JSON
格式
{
"HttpStatusCode":200,
"RequestId":"E993D7CD-D546-4F88-9B04-62DFB05ED7E1",
"Success":true,
"Code":"OK",
"SmsConfigs":{
"SmsConfig":[
{
"Name":"身份验证",
"Description":"验证码${code},您正在进行身份验证,打死不要告诉别人哦!",
"Scenario":2,
"SignName":"阿里大于测试专用",
"Id":24,
"TemplateCode":"SMS_95905021"
},
{
"Name":"漏话短信",
"Description":"你好,刚刚我司员工向您致电,但由于某些原因您未能接听,我们会尽快再次给您致电。",
"Scenario":3,
"SignName":"云呼叫中心",
"Id":25,
"TemplateCode":"SMS_142385986"
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交