GetTransactionalSmsReport

get

https://api.dengage.com/rest/transactional/sms

GetTransactionalSmsReport function gets the report of transactional sms messages by mainly trackingId. Other query parameter options are provided. Please check Request Body Important Notes section.

trackingIds are generated by SendTransactionalSms function call.

Query Params

trackingId

string

length between 36 and 36

uuid of the transaction

tag

string

tag provided while sending the transactional sms

beginTime

string

required

beginTime is the start time of the query. This field is used only if there is no trackingId in the request.

The format is yyyy-MM-dd HH:mm:ss

endTime

string

required

endTime is the start time of the query. This field is used only if there is no trackingId in the request.

The format is yyyy-MM-dd HH:mm:ss

gsm

string

phone number to get report

limit

integer

100 to 1000

offset

integer

≥ 0

transactionalSmsEventType

string

event type to get report

Body Params

Important Notes

When groupId is used, the other query parameters are ignored.
When groupId is not set but there is a transactionId in the request, the other query parameters are ignored.
Either gsm (maximum 5 phone numbers) or tag parameter (maximum 5 tags) can be used at the same time. if the client sends gsm and tag parameters in the same query, gsm query parameter is used and tag is ignored. If the request is made by either tag or gsm query parameter, beginTime and endTime are required.
If a date range is used by beginDate and endDate parameters, queryTime parameters must be set to either "sent" or "event" times.
Maximum data range (the time gap between beginTime and endTime) is 7 days.

Headers

Authorization

string

required

Defaults to {$$.env.access_token}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Not authenticated. Please re-login.

429

Too Many Requests

200

400

403The operation is not allowed. Your api user is not authorized to use this api.