NAV

Direct SMS(Last Updated : 02/04/2021)

PUT Direct SMS

Receive a detailed report of your message blast.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
status Result of the delivered message.
delivery_report The result of a sent message including any reason for failure. See Delivery Report Object table below.
multipart The result of concatenated sms messages.
blocked_mobile The mobile number is inactive due to its being blocked by the carrier. See Blocked Mobile Object table below.
status_code A code notifying the member of the reason for the error. Status Code List

> Delivery Report Object

Parameter Description
sms See SMS Object below.

>> SMS Object

Parameter Description
sms_id The message's unique ID number.
number Mobile phone number.
country_code Country code of the number.
dr_code Delivery report code of the sent message. DR Code List

>> Multipart Object

Parameter Description
multipart_id The Multipart’s unique ID number.
dr_code Delivery report code of the sent message. DR Code List
status The status of multipart message.

> Blocked Mobile Object

Parameter Description
number The mobile phone number.
country_code Country code of the number.

Code sample for PUT Direct SMS


"Example (Success):"
{
    "request_id" : "T201214223240e21a708e",
    "push_id" : 652643,
    "used_credit" : {
        "domestic" : 1,
        "international" : 0
    },
    "status" : "sent",
    "sms" : {
        "sent" : 1,
        "failed" : 0,
        "total" : 1
    },
    "delivery_report" : {
        "sms" : [
            {
                "task_id" : "177675930",
                "number" : "4564564561",
                "country_code" : 1,
                "dr_code" : "DR000"
            }
        ]
    }
}

"Example (Success): Concatenated SMS _ US / CA:"
{
    "request_id" : "T201214223240e21a708e",
    "push_id" : 652643,
    "used_credit" : {
        "domestic" : 2,
        "international" : 0
    },
    "status" : "sent",
    "sms" : {
        "sent" : 1,
        "failed" : 0,
        "total" : 1
    },
    "delivery_report" : {
        "sms" : [
            {
                "task_id" : "177675930",
                "number" : "4564564561",
                "country_code" : 1,
                "dr_code" : "DR000",
                "multipart" : [
                    {
                        "multipart_id" : 50541,
                        "dr_code" : "DR000",
                        "status" : "sent"
                    },
                    {
                        "multipart_id" : 50542,
                        "dr_code" : "DR000",
                        "status" : "sent"
                    }
                ]
            }
        ]
    }
}

"Example (Success): Concatenated SMS _ International:"
{
    "request_id" : "T201214223240e21a708e",
    "push_id" : 652643,
    "used_credit" : {
        "domestic" : 0,
        "international" : 12
    },
    "status" : "sent",
    "sms" : {
        "sent" : 1,
        "failed" : 0,
        "total" : 1
    },
    "delivery_report" : {
        "sms" : [
            {
                "task_id" : "177675930",
                "number" : "4564564561",
                "country_code" : 1,
                "dr_code" : "DR000",
                "multipart" : [
                ]
            }
        ]
    }
}

"Example (Failure):"
{
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "status" : "failed",
    "status_code" : "MRME0101"
}

"Example (Failure): When an outbound message is blocked by the recipient's carrier."
{
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "sms_id" : 987987987987,
    "status" : "failed",
    "blocked_mobile" : {
        "number" : 2003004000,
        "country_code" : 1
    }
}

"Example: When the delivery report is updated by the recipient's carrier after the first push message is sent."
{
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "status" : "sent",
    "sms" : {
        "total" : 1,
        "sent" : 0,
        "failed" : 1
    },
    "delivery_report" : {
        "sms" : [
            {
                "sms_id" : 987987987987,
                "number" : 2003004000,
                "country_code" : 1,
                "dr_code" : "DR007"
            }
        ]
    }
}