Azure Communication SMS Service (preview:2025-05-29)

2025/05/09 • 4 new methods

Sms_Send (new)
Description :  Sends a SMS message from a phone number that belongs to the authenticated account.
Reference :  Link ¶

⚼ Request

POST:  /sms
{
SendMessageRequest:
{
Description: Represents the body of the send message request. ,
Required: True ,
}
{
from:
{
Description: The sender's phone number in E.164 format that is owned by the authenticated account. ,
Required: True ,
}
string ,
smsRecipients:
{
Description: The recipient's phone number in E.164 format. In this version, a minimum of 1 and upto 100 recipients in the list are supported. ,
Required: True ,
}
[
{
to:
{
Description: The recipient's phone number in E.164 format. ,
Required: True ,
}
string ,
repeatabilityRequestId:
{
Description: If specified, the client directs that the request is repeatable; that is, the client can make the request multiple times with the same Repeatability-Request-ID and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-ID is an opaque string representing a client-generated, 36-character hexadecimal case-insensitive encoding of a UUID (GUID), identifier for the request. ,
Required: False ,
}
string ,
repeatabilityFirstSent:
{
Description: MUST be sent by clients to specify that a request is repeatable. Repeatability-First-Sent is used to specify the date and time at which the request was first created.eg- Tue, 26 Mar 2019 16:06:51 GMT ,
Required: False ,
}
string ,
}
,
]
,
message:
{
Description: The contents of the message that will be sent to the recipient. The allowable content is defined by RFC 5724. ,
Required: True ,
}
string ,
smsSendOptions:
{
Description: Optional configuration for sending SMS messages. ,
Required: False ,
}
{
enableDeliveryReport:
{
Description: Enable this flag to receive a delivery report for this message on the Azure Resource EventGrid. ,
Required: True ,
}
boolean ,
tag:
{
Description: Use this field to provide metadata that will then be sent back in the corresponding Delivery Report. ,
Required: False ,
}
string ,
deliveryReportTimeoutInSeconds:
{
Description: Time to wait for a delivery report. After this time a delivery report with timeout error code is generated. ,
Format: int32 ,
Required: False ,
}
integer ,
messagingConnect:
{
Description: Defines optional parameters for connecting with the Messaging Connect Partner to deliver SMS. ,
Required: False ,
}
{
apiKey:
{
Description: Represents the API key associated with the customer's account in the Messaging Connect Partner portal. ,
Required: True ,
}
string ,
partner:
{
Description: Specifies the partner associated with the API key. ,
Required: True ,
}
string ,
}
,
}
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
value:
{
Required: True ,
}
[
{
to:
{
Description: The recipient's phone number in E.164 format. ,
Required: True ,
}
string ,
messageId:
{
Description: The identifier of the outgoing Sms message. Only present if message processed. ,
Required: False ,
}
string ,
httpStatusCode:
{
Description: HTTP Status code. ,
Format: int32 ,
Required: True ,
}
integer ,
repeatabilityResult:
{
Description: The result of a repeatable request with one of the case-insensitive values accepted or rejected. ,
Enum:
{
accepted: No description available. ,
rejected: No description available. ,
}
,
Required: False ,
}
enum ,
successful:
{
Description: Indicates if the message is processed successfully or not. ,
Required: True ,
}
boolean ,
errorMessage:
{
Description: Optional error message in case of 4xx/5xx/repeatable errors. ,
Required: False ,
}
string ,
}
,
]
,
}
OptOuts_Add (new)
Description :  Add phone numbers to the optouts list which shall stop receiving messages from a sender number.
Reference :  Link ¶

⚼ Request

POST:  /sms/optouts:add
{
body:
{
Required: True ,
}
{
from:
{
Description: The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account. ,
Required: True ,
}
string ,
recipients:
{
Required: True ,
}
[
{
to:
{
Description: The recipient's phone number (in E.164 format). ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
to:
{
Description: The recipient phone number (in E.164 format). ,
Required: True ,
}
string ,
httpStatusCode:
{
Format: int32 ,
Required: True ,
}
integer ,
isOptedOut:
{
Description: Optional flag specifying if number was Opted Out from receiving messages ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Optional error message in case of 4xx/5xx errors. ,
Required: False ,
}
string ,
}
,
]
,
}
OptOuts_Remove (new)
Description :  Remove phone numbers from the optouts list.
Reference :  Link ¶

⚼ Request

POST:  /sms/optouts:remove
{
body:
{
Required: True ,
}
{
from:
{
Description: The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account. ,
Required: True ,
}
string ,
recipients:
{
Required: True ,
}
[
{
to:
{
Description: The recipient's phone number (in E.164 format). ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
to:
{
Description: The recipient phone number (in E.164 format). ,
Required: True ,
}
string ,
httpStatusCode:
{
Format: int32 ,
Required: True ,
}
integer ,
isOptedOut:
{
Description: Optional flag specifying if number was Opted Out from receiving messages ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Optional error message in case of 4xx/5xx errors. ,
Required: False ,
}
string ,
}
,
]
,
}
OptOuts_Check (new)
Description :  Check the opt out status for a recipient phone number with a sender phone number.
Reference :  Link ¶

⚼ Request

POST:  /sms/optouts:check
{
body:
{
Required: True ,
}
{
from:
{
Description: The sender's identifier (typically phone number in E.164 format) that is owned by the authenticated account. ,
Required: True ,
}
string ,
recipients:
{
Required: True ,
}
[
{
to:
{
Description: The recipient's phone number (in E.164 format). ,
Required: True ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Version of API to invoke. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
to:
{
Description: The recipient phone number (in E.164 format). ,
Required: True ,
}
string ,
httpStatusCode:
{
Format: int32 ,
Required: True ,
}
integer ,
isOptedOut:
{
Description: Optional flag specifying if number was Opted Out from receiving messages ,
Required: False ,
}
boolean ,
errorMessage:
{
Description: Optional error message in case of 4xx/5xx errors. ,
Required: False ,
}
string ,
}
,
]
,
}