POST api/Sms/SendSms
Request Information
URI Parameters
None.
Body Parameters
SendSmsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| AppId | string |
None. |
|
| TemplateId | string |
None. |
|
| Parameters | Dictionary of string [key] and string [value] |
None. |
|
| Phone | string |
None. |
|
| Sign | string |
None. |
|
| Timestamp | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"AppId": "sample string 1",
"TemplateId": "sample string 2",
"Parameters": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"Phone": "sample string 3",
"Sign": "sample string 4",
"Timestamp": "sample string 5"
}
application/xml, text/xml
Sample:
<SendSmsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fenqibao.DTO.Sms.Request">
<AppId>sample string 1</AppId>
<Parameters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>sample string 2</d2p1:Value>
</d2p1:KeyValueOfstringstring>
<d2p1:KeyValueOfstringstring>
<d2p1:Key>sample string 3</d2p1:Key>
<d2p1:Value>sample string 4</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Parameters>
<Phone>sample string 3</Phone>
<Sign>sample string 4</Sign>
<TemplateId>sample string 2</TemplateId>
<Timestamp>sample string 5</Timestamp>
</SendSmsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SmsBaseResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| status | boolean |
None. |
|
| code | integer |
None. |
|
| msg | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"status": true,
"code": 2,
"msg": "sample string 3"
}
application/xml, text/xml
Sample:
<SmsBaseResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fenqibao.DTO.Sms.Response"> <code>2</code> <msg>sample string 3</msg> <status>true</status> </SmsBaseResponse>