POST /sms/v1/messageContact/{id}/send

Overview

Initiates a message to one or more mobile numbers.

Usage

The phone number must use the correct format for the designated country code. For example, a mobile number from the United States must include the numerical country code 1 and the area code displayed in the sample CSV file. The numerical country code mentioned here applies only to the phone number itself, and that any separate field containing country code information must conform to ISO-3306-1 alpha-2 standards.

Example Request

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /sms/v1/messageContact/MzA6Nzg6MA/send
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "mobileNumbers": [
    "13175551212"
    ],
    "Subscribe": true,
    "Resubscribe": true,
    "keyword": "JOINSMS",
    "Override": true,
    "messageText": "Welcome to Code@",
    "ContentURL" : "http://image.exct.net/lib/fe6d15707662057c7411/m/1/dj_CC_AUS.jpg",
    "SendTime": "2012-10-05 20:01"
}

To ensure that the mobile number exists for the contact and that the contact subscribed to the specified keyword on your short code, set the Subscribe and Resubscribe values to true.

To provide an alternate unique value for referencing these records, pass another identifier with the mobile number. You cannot pass both the Subscribers parameter and a mobileNumber parameter outside of a Subscribers parameter. Choose the option that best fits your call.

The MobileConnect message with API key MzA6Nzg6MA is saved in Marketing Cloud with only one open personalization string equal to %%FirstName%%. The following call sends two messages: one with "Michael" used for first name, the other with "Kristen".

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /sms/v1/messageContact/MzA6Nzg6MA/send
Content-Type: application/json
{
    "Subscribers": [
        {
        "MobileNumber": "15555554410",
        "SubscriberKey": "ExampleSubKey1",
        "Attributes":{
            "FirstName":"Michael"
            }
        },
        {
        "MobileNumber": "15555552254",
        "SubscriberKey": "ExampleSubKey2",
        "Attributes":{
            "FirstName":"Kristen"
            }
        }
    ],
    "Subscribe": "true",
    "Resubscribe": "true",
    "keyword": "JOINSMS",
    "Override": "false",
    "SendTime": "2012-10-05 20:01"
}

Example Response

If the request is valid, the API returns a token that can be used to make a follow-up call to check the status of the request.

HTTP/1.1 202 Accepted
{
  "tokenId": "c21NCNSDN2sMMWM2miosdjEHH",
}

Error Response

If the request was not valid, the API returns a 400 response with details on the error. This example includes the following errors:

• The keyword does not exist in the account
• The mobile number includes hyphens

  HTTP/1.1 400 Bad Request
  {
  "errors" : ["1-317-555-1212 is not a numeric string",
      "Keyword TestKeyword is invalid for the code on the message"]
  }