Skip to content

DataFlowsSmsClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'RegisterWebhook': {'operation_id': 'RegisterWebhook', 'path': '/{connectionId}/power-automate/webhooks/register', 'method': 'post', 'required_parameters': ['body'], 'callback_payload_type': 'RegisterWebhookResponse'}}

Classes

SmsResponse dataclass

SmsResponse(*, status: Optional[str] = None, data: Optional[Dict[str, Any]] = None, message: Optional[str] = None)

Response for Send SMS via GET (Alternative method)

Attributes

data class-attribute instance-attribute
data: Optional[Dict[str, Any]] = dataclass_field(default=None, kw_only=True)

SMS report details with message ID, cost, and delivery info

message class-attribute instance-attribute
message: Optional[str] = dataclass_field(default=None, kw_only=True)

Human-readable response message

SendSmsInput dataclass

SendSmsInput(recipient: str, sender_id: str, message: str, type_: str, *, schedule_time: Optional[str] = None, dlt_template_id: Optional[str] = None)

Send SMS Message

Attributes

recipient instance-attribute
recipient: str

Phone number(s) to send SMS. Use comma (,) to separate multiple numbers

sender_id instance-attribute
sender_id: str

The sender ID (alphanumeric string max 11 chars or phone number with country code)

message instance-attribute
message: str

The SMS message content

schedule_time class-attribute instance-attribute
schedule_time: Optional[str] = dataclass_field(default=None, kw_only=True)

Schedule message for future delivery (Y-m-d H:i format)

dlt_template_id class-attribute instance-attribute
dlt_template_id: Optional[str] = dataclass_field(default=None, kw_only=True)

DLT template ID for regulatory compliance

SmsDetails dataclass

SmsDetails(*, status: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Get SMS Details

SmsList dataclass

SmsList(*, status: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for List All SMS Messages

Profile dataclass

Profile(*, status: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Get Account Profile

Balance dataclass

Balance(*, status: Optional[str] = None, data: Optional[Dict[str, Any]] = None)

Response for Get Account Balance

RegisterWebhookInput dataclass

RegisterWebhookInput(webhook_url: str, trigger_type: str, virtual_number: str)

When SMS received

Attributes

trigger_type instance-attribute
trigger_type: str

Select the type of event that will trigger this flow

virtual_number instance-attribute
virtual_number: str

Select the virtual number to monitor for incoming SMS messages.

RegisterWebhookResponse dataclass

RegisterWebhookResponse(*, status: Optional[str] = None, webhook_id: Optional[str] = None, message: Optional[str] = None)

Response for When SMS received

Attributes

webhook_id class-attribute instance-attribute
webhook_id: Optional[str] = dataclass_field(default=None, kw_only=True)

Unique webhook identifier

UnregisterWebhookResponse dataclass

UnregisterWebhookResponse(*, status: Optional[str] = None, message: Optional[str] = None)

Response for Unregister Webhook

SmsRequest dataclass

SmsRequest(recipient: str, sender_id: str, type_: str, message: str, *, schedule_time: Optional[str] = None, dlt_template_id: Optional[str] = None)

Definition: SMSRequest

Attributes

recipient instance-attribute
recipient: str

Phone number(s) to send SMS. Use comma (,) to separate multiple numbers

sender_id instance-attribute
sender_id: str

The sender ID (alphanumeric string max 11 chars or phone number with country code)

type_ class-attribute instance-attribute
type_: str = dataclass_field(metadata={'wire_name': 'type'})

Message type (plain for regular text, unicode for special characters)

message instance-attribute
message: str

The SMS message content

schedule_time class-attribute instance-attribute
schedule_time: Optional[str] = dataclass_field(default=None, kw_only=True)

Schedule message for future delivery (Y-m-d H:i format)

dlt_template_id class-attribute instance-attribute
dlt_template_id: Optional[str] = dataclass_field(default=None, kw_only=True)

DLT template ID for regulatory compliance

SenderIds dataclass

SenderIds(*, status: Optional[str] = None, value: Optional[List[str]] = None)

Definition: SenderIds

Attributes

value class-attribute instance-attribute
value: Optional[List[str]] = dataclass_field(default=None, kw_only=True)

List of active sender IDs available for the account

ErrorResponse dataclass

ErrorResponse(*, status: Optional[str] = None, message: Optional[str] = None)

Definition: ErrorResponse

Attributes

message class-attribute instance-attribute
message: Optional[str] = dataclass_field(default=None, kw_only=True)

Human-readable error description

DataFlowsSmsClient

DataFlowsSmsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for dataflowssms connector.

Initialize a DataFlowsSmsClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

required
credential AsyncTokenCredential | AzureKeyCredential

Caller-owned Azure Core credential.

required
max_retry_attempts int

The maximum number of request attempts.

3
timeout float

The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.

30.0
use_exponential_backoff bool

Whether retries use exponential backoff.

True
initial_retry_delay_seconds float

The initial retry delay in seconds.

0.5
maximum_retry_delay_seconds float

The maximum retry delay in seconds.

120.0
retry_jitter_factor float

The jitter fraction applied to retry delays.

0.1
retry_unsafe_http_methods bool

Whether unsafe HTTP methods may be retried.

False
transport Optional[AsyncHttpTransport]

Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.

None
**kwargs Any

Optional Azure Core pipeline policy settings.

{}

Methods:

send_sms_get async
send_sms_get(recipient: str, sender_id: str, message: str, *, type_: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send SMS via GET (Alternative method)

Send SMS using GET parameters (for simple integrations)

Swagger operation ID: SendSMSGet.

Parameters:

Name Type Description Default
recipient str

Recipient phone number.

required
sender_id str

Sender ID.

required
message str

Message content.

required
type_ Optional[str]

Message type.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

send_sms async
send_sms(input: SendSmsInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Send SMS Message

Send single or multiple SMS messages through DataFlows SMS platform. Supports scheduling, multiple recipients, and delivery tracking.

Swagger operation ID: SendSMS.

Parameters:

Name Type Description Default
input SendSmsInput | Mapping[str, Any]

The request body. Mapping keys use serialized Swagger wire names.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

get_sms async
get_sms(uid: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get SMS Details

Retrieve details of a specific SMS message by its unique ID

Swagger operation ID: GetSMS.

Parameters:

Name Type Description Default
uid str

Unique message identifier.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

list_sms async
list_sms(*, page: Optional[int] = None, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

List All SMS Messages

Get paginated list of all SMS messages for the account

Swagger operation ID: ListSMS.

Parameters:

Name Type Description Default
page Optional[int]

Page number for pagination.

None
limit Optional[int]

Number of messages per page.

None
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

get_profile async
get_profile(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Account Profile

Retrieve account profile information

Swagger operation ID: GetProfile.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

get_balance async
get_balance(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Account Balance

Retrieve current SMS credit balance

Swagger operation ID: GetBalance.

Parameters:

Name Type Description Default
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.

unregister_webhook async
unregister_webhook(webhook_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Unregister Webhook

Remove a previously registered webhook subscription. Authentication is done via the Authorization header.

Swagger operation ID: UnregisterWebhook.

Parameters:

Name Type Description Default
webhook_id str

The webhook ID to unregister.

required
timeout Optional[float]

The request timeout in seconds.

None
headers Optional[Mapping[str, str]]

Additional HTTP request headers.

None
client_request_id Optional[str]

A caller-provided request identifier.

None
response_hook Optional[ConnectorResponseHook]

A callback invoked with the connector response.

None

Returns:

Type Description
dict[str, Any] | None

dict[str, Any] | None: The connector operation result.

Raises:

Type Description
ConnectorException

If the connector request fails.