Text Message Transaction Details

Text Message Transaction Details

Description¶

The textMessageTransactionDetailsToRecipients endpoint facilitates the delivery of transaction details to designated recipients through Text message.

Request¶

Endpoint¶
/ui/v1/textMessageTransactionDetailsToRecipients
Method¶
POST
Header¶

Content-Type: application/json
Authorization: Basic $TOKEN

Note

Replace $TOKEN in the request with the base64-encoded username/password combination in the format username:password.

Given a username of username and a password of password, the request header would appear as follows:

Content-Type: application/json
Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=

Request Body¶

{
    "orderId": [
        "100000001234",
        null
    ],
    "emailAddress": [
        "1231231233@txt.att.net,1231231233@mms.att.net",
        "",
        "",
        "",
        ""
    ],
    "mobileCountryCallingCode": [
        "1",
        "",
        "",
        "",
        ""
    ],
    "numberOfRecipients": 1,
    "merchantId": 11,
    "transactionInfoId": 12345,
    "locale": {
        "name": "en_US"
    },
    "textMessageType": [
        {
            "name": "SMS"
        },
        {
            "name": "SMS"
        },
        {
            "name": "SMS"
        },
        {
            "name": "SMS"
        },
        {
            "name": "SMS"
        }
    ]
}

Response¶

{
    "records": null,
    "recordCount": null,
    "message": {
        "code": "100",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "RECIPIENT_TEXT_MESSAGE_SENT_SUCCESS",
        "parameters": null
    }
}

Updated As Of Version 6.7.0