/messages/failed

POST

/messages/failed

Get failed messages matching your search criteria

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.thesmsworks.co.uk/v1/messages/failed' \
--header 'Content-Type: application/json' \
--data-raw '{
    "credits": 2,
    "destination": "447777777777",
    "from": "Wed Jul 12 2017 20:26:28 GMT+0100 (BST)",
    "keyword": "SKYWALKER",
    "metadata": [
        {
            "key": "myKey1",
            "value": "myValue1"
        },
        {
            "key": "myKey2",
            "value": "myValue2"
        }
    ],
    "sender": "YourCompany",
    "status": "SENT",
    "to": "Wed Jul 19 2017 20:26:28 GMT+0100 (BST)",
    "unread": true
}'

Response Example

200 - Example 1

[
    {
        "batchid": "2586749",
        "content": "My super awesome message",
        "created": "Wed Jul 19 2017 20:53:46 GMT+0100 (BST)",
        "customerid": "0fca8c3c-6cbc-11e7-8154-a6006ad3dba0",
        "deliveryreporturl": "https://your.domain.com/delivery/report/path",
        "destination": "447777777777",
        "failurereason": {
            "code": 34,
            "details": "Handset error",
            "permanent": false
        },
        "id": 123456789,
        "identifier": 7777777777,
        "keyword": "CALRISSIAN",
        "messageid": 123456789,
        "modified": "Wed Jul 19 2017 20:53:49 GMT+0100 (BST)",
        "schedule": "Wed Jul 19 2017 20:53:45 GMT+0100 (BST)",
        "sender": "YourCompany",
        "status": "DELIVERED",
        "tag": "campaign2"
    }
]

Request

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🔴500Error

Modified at 2022-09-11 19:34:57

/messages

/messages/inbox