Skip to main content
POST /v1/messages/sendSms Enables merchants to send SMS messages to users via their access tokens.

Request Parameters

accessToken
string
required
Auth token identifying the target user.Max length: 128 characters
requestId
string
required
Unique transaction ID for idempotency.Max length: 128 characters
templateCode
string
required
Template identifier for the SMS.Max length: 256 characters
templates
array
required
Content templates. Maximum 5 items. Each item is a ContentTemplate object.
authClientId
string
Unique auth client ID.Max length: 128 characters
extendInfo
string
Additional metadata.Max length: 4096 characters

Response Parameters

result
object
required
Standard result object with resultCode, resultStatus, resultMessage
messageId
string
Unique message identifier.Max length: 258 characters
extendInfo
string
Additional response metadata.Max length: 4096 characters

Result Codes

resultStatusresultCodeDescription
SSUCCESSSMS sent successfully
FINVALID_AUTH_CLIENTInvalid authentication client
FUSER_STATUS_ERRORAccount locked or unregistered
FVERIFY_REQUEST_ID_INVALIDMalformed requestId
FTEMPLATE_VARIABLE_NOT_COMPLETEIncomplete template variable replacement
FGOTONE_UNIQ_ERRORDuplicate request detected
UUNKNOWN_EXCEPTIONUnknown error occurred