SMS Single Record Query - nxtele/nxcloud-doc-en GitHub Wiki

Brief Description:

  • SMS Record Through messageid for a single record

Request Method:

  • URL:http://api2.nxcloud.com/api/sms/get
  • Method:POST
  • Content-Type:application/x-www-form-urlencoded

Parameters:

Parameter Name Required Type Description
appkey Yes string SMS Application appkey
secretkey Yes string SMS Application secretkey
date Yes string Date(yyyyMMdd)
messageid Yes string message id

Request Example:

curl --location --request POST 'http://api2.nxcloud.com/api/sms/ge' \
--data-urlencode 'appkey=asdf' \
--data-urlencode 'secretkey=qwer' \
--data-urlencode 'date=20230202' \
--data-urlencode 'messageid=qwer1234567890'

ReturnExample

{
    "code": "0",
    "row": {
        "billing_size": 1,
        "date": "2021-06-28 09:00:00",
        "senderid": "666",
        "phone": "6288888888888",
        "dr_time": "2021-06-28 09:00:00",
        "billing_price": 0.0,
        "msgid": "xxxxxxxxxxxxxxxxxxxxxxxx",
        "billing_status": "UnBilled",
        "body": "hello, your code is 888888",
        "dr_status": "Success",
        "dr": "DELIVRD",
        "network": "PT TELEKOMUNIKASI SELULAR"
    }
}

ReturnParametersDescription

Parameter Name Type Description
code string Return Value
senderid string sender / source address
body string SMS Content
phone string Phone number, may not the same as committed
msgid string message id
dr_status string DR(Success,Fail)
billing_size number billing size
billing_price number billing Price
date string SendDate
dr_time string drDate
billing_status string Billing Status(Billed,UnBilled)
network string Operator
dr string delivery report

Remarks

  • Error Code
code Description
0 success
1 params invalid
2 keys invalid
3 Only recent 31 days