All Products
Search
Document Center

Short Message Service:SMS webhook

Last Updated:Jul 04, 2024

You can configure a Message Service (MNS) queue to receive delivery receipts.

Prerequisites

  • An Alibaba Cloud account and an AccessKey pair are created. For more information, see Obtain an AccessKey pair.

  • The MNS queue has access to the following domain names: dybaseapi.ap-southeast-1.aliyuncs.com and 1493622401794734.mns.ap-southeast-1.aliyuncs.com.

Important

The idempotence of delivery receipts cannot be guaranteed. We recommend that you take appropriate measures to ensure the correctness and consistency of your data after receiving a delivery receipt.

Request parameters

Parameter

Type

Example

Description

To

String

8521234****

The mobile phone number that receives delivery receipts.

Status

String

1

The status of the message.

  • 1: The message was sent.

  • 2: The message failed to be sent.

  • 6: The message expired.

MessageId

String

123456789****

The ID of the delivery receipt.

SmsSize

String

1

The number of messages.

A long message is split into multiple messages.

SendDate

String

Thu, 25 Nov 2021 10:27:00 +0800

The time when the message was sent to the carrier.

ReceiveDate

String

Thu, 25 Nov 2021 10:27:33 +0800

The time when the delivery receipt was received from the carrier.

ErrorCode

String

success

The error code.

ErrorDescription

String

success

The error message.

Example

{
    "To" : "8521234****",
    "SendDate" : "Thu, 25 Nov 2021 10:27:00 +0800",
    "ReceiveDate" : "Thu, 25 Nov 2021 10:27:33 +0800",
    "Status" : "1",
    "SmsSize":"1",
    "ErrorCode" : "success",
    "ErrorDescription" : "success",
    "MessageId" : "123456789****"
  }