SMS Report - nxtele/nxcloud-doc-en GitHub Wiki
Brief Description：
- SMS usage Report
Request Method：
- URL：
http://api2.nxcloud.com/api/sms/getSmsReport - Method：
POST - Content-Type：
application/x-www-form-urlencoded
Parameters：
| Parameters Name | Required | Type | Description |
|---|---|---|---|
| appkey | Yes | string | SMS Application appkey |
| secretkey | Yes | string | SMS Application secretkey |
| start_date | Yes | string | StartTime（yyyy-MM-dd） |
| end_date | Yes | string | EndTime （yyyy-MM-dd） |
Request Example：
curl --location --request POST 'http://api2.nxcloud.com/api/sms/getSmsReport' \
--data-urlencode 'appkey=asdf' \
--data-urlencode 'secretkey=qwer' \
--data-urlencode 'start_date=2023-02-02' \
--data-urlencode 'end_date=2023-02-05'
ReturnExample
{
"code": "0",
"row": [
{
"total_fee": 14.25,
"submit_size": 95,
"success_size": 82,
"price_size": 82
}
]
}
ReturnParametersDescription
| ParametersName | Type | Description |
|---|---|---|
| code | string | status code, 0 for success |
| total_fee | number | Total fee |
| submit_size | number | SMS Submissions no. |
| success_size | number | Successful no. |
| price_size | number | Charging no. |
Remarks
- Error Code
| code | Description |
|---|---|
| 0 | success |
| 1 | params invalid |
| 2 | keys invalid |
| 5 | api request times invalid |