# 1.2 Sms Callback

# Descrption

  • This interface is implemented by the merchant. Its function is that when the SMS is successfully sent, Bluepay will call this interface to notify the merchant of the SMS sending details.

# URL

  • Provided by merchant.

# Method

  • POST

# Request Header

Parameter name Required Type of data Description
Content-Type Y string application/json

# equest Params

Parameter name Required Type of data Length Example description
param Y string - - Parameter Body
sign Y string - - Sign

# Request param

parameter name required type description
eventName Y string Event Name( sms.send.success
requestId Y string Merchant Sms request ID
smsId Y string Bluepay Sms ID
bizType Y string Business Type: OTPMARKETING
mobileNum Y string Thai mobile phone
templateCode Y string Sms Template ID
smsContent Y string Sms Content
smsStatus Y string SMS Send status PENDING, SUCCESS, FAIL

# Response parameters

paramter name type description
code integer Response code, fixed value 10000
message string Response message, fixed value Success

# Request example

# param content

{
  "eventName": "sms.send.success",
  "requestId": "REQ202601210001",
  "smsId": "SMS000000001",
  "bizType": "MARKETING",
  "mobileNum": "08123456789",
  "templateCode": "SMS_001",
  "smsContent": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "smsStatus": "SUCCESS"
}

How Bluepay construct request body

# Request body

{
  "sign": "V6HQvEZaLF5MSH8TcOVdqPj7fLyvdrAOPm74rW9svpclBIVPlokyiZqPXl09/yAOS8PNnganUtvRvie9MAxJwtYOkDMXxxi4gWjPl3D9L6W4fnVeC28HjhZhWrSgwlecJG6SuHM3odTHAxr5WQUuOxsYFtx+c74Ew+ZzuICCH3dA4+uzNEbDyB8QmBF94nM1LFhDId/VEMxdbj8xKJuOMiSBgwAWaFElm5YCfgmrZpU/qLnuGX2hNxQAMKY2GAw+4VpphYpHG8Xak5+PlqFWKp8mKJ9DgyphVf0ACGpcjOQp0S1V+S1HMMVU0AkW6c8n0weOMu3l6k6cPHsjEe/jSQ==",
  "param": "{\"eventName\":\"sms.send.success\",\"requestId\":\"REQ202601210001\",\"smsId\":\"SMS000000001\",\"bizType\":\"MARKETING\",\"mobileNum\":\"08123456789\",\"templateCode\":\"SMS_001\",\"smsContent\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"smsStatus\":\"SUCCESS\"}"
}

# Response example

{
  "code": 10000,
  "message": "Success"
}