SMS Response

When SMS is submitted, the server replies with a message response which shows the submit status of the destinations as well as a reference to the message batch submitted.

It should be emphasised that message response which is received after submitting a message is not a delivery response. A delivery response is returned when a separate Delivery Status Request is made as discussed under Delivery Status Reporting.

The following shows a sample Message Response after submitting a message.

JSON
XML

{
    "handshake" : {
        "id" : 0,
        "label" : "HSHK_OK"
    },
    "data": {
        "batch" : "cfa19ba67f94fbd6b19c067b0c87ed4f",
        "category": 1,
        "delivery": false,
        "destinations": [
            {
                "id" : "093841e5-578a-41f4-5f5f-2f3910886c12",
                "to" : "233246314915",
                "status" : {
                    "id" : 2105,
                    "label" : "DS_PENDING_ENROUTE"
                }
            },
            {
                "id" : "4abfa3bd-93f9-b8a1-4bbd-78725ca3e488",
                "to" : "233242053072",
                "status" : {
                    "id" : 2105,
                    "label" : "DS_PENDING_ENROUTE"
                }
            }
        ]
    }
}

<response>
    <handshake>
        <id>key</id>
        <label>HSHK_OK</label>
    </handshake>
    <data>
        <batch>cfa19ba67f94fbd6b19c067b0c87ed4f</batch>
        <category>1</category>
        <delivery>false</delivery>
        <destinations>
            <item>
                <id>093841e5-578a-41f4-5f5f-2f3910886c12</id>
                <to>233241234567</to>
                <status>
                    <id>2105</status>
                    <label>DS_PENDING_ENROUTE</label>
                </status>
            </item>
            <item>
                <id>4abfa3bd-93f9-b8a1-4bbd-78725ca3e488</id>
                <to>233501234567</to>
                <status>
                    <id>2105</status>
                    <label>DS_PENDING_ENROUTE</label>
                </status>
            </item>
        </destinations>
    </data>
</response>

The discussion on Message Response delves deeper into the various parts for message response processing.