Query SMS Send Records


HTTP Header:


Accept: application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


URL:https://sms.yunpian.com/v2/sms/get_record.json


Request:


Method: POST


Request Parameter:

PARAMETERTYPEREQUIREDDESCRIPTIONEXAMPLE
apikeystringYesAPIKEY is credentials you can find on the "Account Dashboard" page. It is the string of 32-bit characters.9b11127a9701975c
734b8aee81ee3526
mobilestringNoThe destination phone number. Multi mobiles should be separated by comma.+93701234567
start_timestringYesThe start time for the SMS sent.2013/8/11 0:00
end_timestringYesThe end time for the SMS sent.2013/8/12 0:00
page_numintegerNoPage number, the default value is 1.1
page_sizeintegerNoThe maximum number of pages per page. The maximum number is 100.20
typestringNoSelect the type of SMS, it is empty by default. You can only get the domestic SMS records by default. If you set it as " global", only can get international SMS records. If you set it as " all", both the domestic and international records are available.global


Response:


JSON Representations:


[
    {
        "sid": 1234567890,
        "mobile":"+93701234567",
        "send_time":"2015-11-02 16:34:56",
        "text": "【YunPian】Your verification code is 8888",
        "send_status":"SUCCESS",
        "report_status":"FAIL",
        "fee":1,
        "user_receive_time":null,
        "error_msg":"1:1",
        "uid":null
    },
    {
        "sid": 1234567891,
        "mobile":"+93701234567"
        "send_time":"2015-11-02 15:34:42"
        "text": "【YunPian】Your verification code is 1234",
        "send_status":"SUCCESS",
        "report_status":"FAIL",
        "fee":1,
        "user_receive_time":null,
        "error_msg":"1:1",
        "uid":null
    }
]


Response Parameter:

PARAMETERTYPEDESCRIPIONEXAMPLE
sidlong(64 bit)SMS ID16741236146
mobilestringThe mobile reply this message."15205201314"
send_timestringSMS send time"2015-11-02 16:34:56"
textstringSMS text"【YunPian】Your verification code is 8888"
send_statusstringSend status"SUCCESS"
report_statusstringReport status"FAIL"
feedoubleDeduction Amount. One SMS can support 70 words. If the words is more than 70 words, will separate it per 67 words .1
user_receive_timestringUser receive time"2015-11-02 16:34:56"
error_msgstringIf SMS does not be received successfully, it will show error code."1:1"
uidstringSMS ID defined by user. If not set, it will show null."1234567"