Skip to Content
Short Message Service(USMS)GetUSMSTemplateSendStatistics

Get Template Send Statistics Data - GetUSMSTemplateSendStatistics

Overview

Obtain Template Sending Statistics Data

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is GetUSMSTemplateSendStatistics.Yes
PublicKeystringThe user’s public key can be obtained from Console Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. Leave it blank for the default project. Sub-accounts must fill in. Please refer to the GetProjectList APIYes
PageintPage number, starting from 0Yes
NumPerPageintNumber of records per pageYes
OrderBystringSort field, such as BrevityCode means sorting by BrevityCode, used in conjunction with OrderType. Currently supports SendDate, BrevityCode.Yes
OrderTypestringSorting method, asc - ascending order desc - descending orderYes
StartDatestringStart date, format is YYYY-MM-DDYes
EndDatestringEnd date, format is YYYY-MM-DDYes
DomesticintDomestic tag, 0-International SMS 1-Domestic SMSYes
BrevityCodestringInternational short codes, such as ‘CN’ represents China. When querying multiple countries, use ’-’ to separate, such as ‘CN-ID’.No
TemplateIdstringSMS Template IDNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
TotalintReturn Record CountYes
StatisticsDataStatisticsDataThe sum set of sending data statistics that meet the query conditions, see the StatisticsData model for specific field information.Yes
Dataarray[TemplateStatisticsDataInfo]The collection of send data statistics based on the day as the statistical dimension, the statistical data fields of each day are detailed in the TemplateStatisticsDataInfo model.No

Data Model

StatisticsData

Field NameTypeDescription InformationRequired
UnknownCountintUnknown Status Quantity (Number of Submissions)Yes
SuccessCountintNumber of Successful Sendings (Submission Count)Yes
SendCostCountintTotal Sent (Split Count)Yes
FailCountintNumber of Failed Sendings (Submission Count)Yes
SendCountintTotal Sent (Number of Submissions)Yes
SuccessCostCountintNumber of Successful Sends (Split Counts)Yes
FailCostCountintNumber of Failed Sends (Split Count)Yes
UnknownCostCountintUnknown Status Quantity (Split Count)Yes
SubmitFailCountintSubmission Failure Count (Number of Submissions)Yes
SubmitFailCostCountintSubmission Failure Count (Split Count)Yes

TemplateStatisticsDataInfo

Field NameTypeDescription InformationRequired
SendDatestringSend TimeYes
BrevityCodestringInternational/Regional Identification CodeYes
TemplateIdstringSMS Template IDYes
CountintTotal Sent (Number of Submissions)Yes
CostCountintTotal Sent (Split Count)Yes
SuccessCountintNumber of Successful Sendings (Submission Count)Yes
SuccessCostCountintNumber of Successful Sends (Split Counts)Yes
FailedCountintNumber of Failed Sendings (Submission Count)Yes
FailedCostCountintNumber of Failed Sends (Split Count)Yes
UnknownCountintUnknown Status Quantity (Number of Submissions)Yes
UnknownCostCountintUnknown Status Quantity (Split Count)Yes
SubmitFailedCountintSubmission Failure Count (Number of Submissions)Yes
SubmitFailedCostCountintSubmission Failure Count (Split Count)Yes

Example

Request Example

https://api.ucloud-global.com/?Action=GetUSMSTemplateSendStatistics &ProjectId=NisAYPmv &Page=5 &NumPerPage=5 &OrderBy=jOdlouXH &OrderType=umirvnPn &StartDate=pkwNCtsO &EndDate=fOEqzdNm &Domestic=5 &BrevityCode=sXFqlpJN &TemplateId=frUFWoVs

Response Example

{ "Action": "GetUSMSTemplateSendStatisticsResponse", "Data": [ { "BrevityCode": "kbBFlxEg", "CostCount": 1, "Count": 9, "FailedCostCount": 3, "FailedCount": 7, "SendDate": "aGQopQIl", "SubmitFailedCostCount": 1, "SubmitFailedCount": 7, "SuccessCostCount": 4, "SuccessCount": 4, "TemplateId": "JelSfPNU", "UnknownCostCount": 6, "UnknownCount": 3 } ], "Message": "iCneNUGy", "RetCode": 0, "StatisticsData": {}, "Total": 2 }