PlivoClient
Classes
dataclass
MakeCallResponse(*, api_id: Optional[str] = None, message: Optional[str] = None, request_uuid: Optional[str] = None)
Response for Make a call
Attributes
class-attribute
instance-attribute
Unique ID of the API request.
class-attribute
instance-attribute
Response obtained when the call was made.
dataclass
ListMessagesResponse(*, api_id: Optional[str] = None, meta: Optional[Dict[str, Any]] = None, objects: Optional[List[Dict[str, Any]]] = None)
Response for List all messages
Attributes
class-attribute
instance-attribute
Unique ID of the API request.
class-attribute
instance-attribute
Meta information about the response.
dataclass
SendSMSResponse(*, api_id: Optional[str] = None, message: Optional[str] = None, message_uuid: Optional[List[str]] = None)
Response for Send SMS
Attributes
class-attribute
instance-attribute
Unique ID of the API request.
class-attribute
instance-attribute
Response of the sent message.
dataclass
GetMessageResponse(*, api_id: Optional[str] = None, error_code: Optional[str] = None, from_number: Optional[str] = None, message_direction: Optional[str] = None, message_state: Optional[str] = None, message_time: Optional[str] = None, message_type: Optional[str] = None, message_uuid: Optional[str] = None, resource_uri: Optional[str] = None, to_number: Optional[str] = None, total_amount: Optional[str] = None, total_rate: Optional[str] = None, units: Optional[int] = None)
Response for Get message
Attributes
class-attribute
instance-attribute
Unique ID of the API request.
class-attribute
instance-attribute
Delivery error code if the message isn't delivered.
class-attribute
instance-attribute
Number from which the message was sent.
class-attribute
instance-attribute
Direction of the message (inbound/outbound).
class-attribute
instance-attribute
Status of the message (queued/sent/delivered/failed).
class-attribute
instance-attribute
Timestamp at which the message was sent or received (yyyy-MM-dd HH:mm:ss UTC).
class-attribute
instance-attribute
Type of the message.
class-attribute
instance-attribute
Unique ID of the message.
class-attribute
instance-attribute
URI to get details of this single message.
class-attribute
instance-attribute
Number to which the message was sent.
class-attribute
instance-attribute
Amount charged for the message.
class-attribute
instance-attribute
Rate per unit of the message.
dataclass
dataclass
Definition: Call
Attributes
class-attribute
instance-attribute
Plivo number to be used to make the call.
PlivoClient(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 plivo connector.
Initialize a PlivoClient.
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:
async
make_call(input: Call | Mapping[str, Any], auth_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
Make a call
This operation is used to make a call.
Swagger operation ID: MakeCall.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
Call | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
auth_id
|
str
|
Auth ID of your Plivo account. |
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_messages(auth_id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]
List all messages
This operation returns a list of all messages associated with your Plivo account.
Returns a single-page Azure Core async collection.
Swagger operation ID: ListMessages.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
auth_id
|
str
|
Auth ID of your Plivo account. |
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 |
|---|---|
AsyncItemPaged[dict[str, Any]]
|
AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector
results. Consume it with |
Raises:
| Type | Description |
|---|---|
ConnectorException
|
If the connector request fails. |
async
send_sms(input: SMS | Mapping[str, Any], auth_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
Send SMS
This operation is used to send a text message.
Swagger operation ID: SendSMS.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SMS | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
auth_id
|
str
|
Auth ID of your Plivo account. |
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. |
async
get_message(auth_id: str, message_uuid: 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 message
This operation is used to fetch the details of a message, given the message ID.
Swagger operation ID: GetMessage.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
auth_id
|
str
|
Auth ID of your Plivo account. |
required |
message_uuid
|
str
|
UUID of the message for which the details need to be fetched. |
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. |