PlivoClient

Classes

MakeCallResponse dataclass

MakeCallResponse(api_id: Optional[str] = None, message: Optional[str] = None, request_uuid: Optional[str] = None)

Response for Make a call

Attributes

api_id class-attribute instance-attribute

api_id: Optional[str] = None

Unique ID of the API request.

message class-attribute instance-attribute

message: Optional[str] = None

Response obtained when the call was made.

request_uuid class-attribute instance-attribute

request_uuid: Optional[str] = None

Unique ID of the call.

ListMessagesResponse 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

api_id class-attribute instance-attribute

api_id: Optional[str] = None

Unique ID of the API request.

meta class-attribute instance-attribute

meta: Optional[Dict[str, Any]] = None

Meta information about the response.

objects class-attribute instance-attribute

objects: Optional[List[Dict[str, Any]]] = None

Details of all messages.

SendSMSResponse dataclass

SendSMSResponse(api_id: Optional[str] = None, message: Optional[str] = None, message_uuid: Optional[List[str]] = None)

Response for Send SMS

Attributes

api_id class-attribute instance-attribute

api_id: Optional[str] = None

Unique ID of the API request.

message class-attribute instance-attribute

message: Optional[str] = None

Response of the sent message.

message_uuid class-attribute instance-attribute

message_uuid: Optional[List[str]] = None

Unique ID of the message.

GetMessageResponse 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

api_id class-attribute instance-attribute

api_id: Optional[str] = None

Unique ID of the API request.

error_code class-attribute instance-attribute

error_code: Optional[str] = None

Delivery error code if the message isn't delivered.

from_number class-attribute instance-attribute

from_number: Optional[str] = None

Number from which the message was sent.

message_direction class-attribute instance-attribute

message_direction: Optional[str] = None

Direction of the message (inbound/outbound).

message_state class-attribute instance-attribute

message_state: Optional[str] = None

Status of the message (queued/sent/delivered/failed).

message_time class-attribute instance-attribute

message_time: Optional[str] = None

Timestamp at which the message was sent or received (yyyy-MM-dd HH:mm:ss UTC).

message_type class-attribute instance-attribute

message_type: Optional[str] = None

Type of the message.

message_uuid class-attribute instance-attribute

message_uuid: Optional[str] = None

Unique ID of the message.

resource_uri class-attribute instance-attribute

resource_uri: Optional[str] = None

URI to get details of this single message.

to_number class-attribute instance-attribute

to_number: Optional[str] = None

Number to which the message was sent.

total_amount class-attribute instance-attribute

total_amount: Optional[str] = None

Amount charged for the message.

total_rate class-attribute instance-attribute

total_rate: Optional[str] = None

Rate per unit of the message.

units class-attribute instance-attribute

units: Optional[int] = None

Number of units the message was split into.

SMS dataclass

SMS(src: Optional[str] = None, dst: Optional[str] = None, text: Optional[str] = None)

Definition: SMS

Attributes

src class-attribute instance-attribute

src: Optional[str] = None

Plivo number from which the message is to be sent.

dst class-attribute instance-attribute

dst: Optional[str] = None

Phone number to which the message is to be sent.

text class-attribute instance-attribute

text: Optional[str] = None

Text of the message to be sent.

Call dataclass

Call(from_: Optional[str] = None, to: Optional[str] = None, answer_url: Optional[str] = None, answer_method: Optional[str] = None)

Definition: Call

Attributes

from_ class-attribute instance-attribute

from_: Optional[str] = field(default=None, metadata={'wire_name': 'from'})

Plivo number to be used to make the call.

to class-attribute instance-attribute

to: Optional[str] = None

The phone number to call.

answer_url class-attribute instance-attribute

answer_url: Optional[str] = None

URL to be called when the call is made.

answer_method class-attribute instance-attribute

answer_method: Optional[str] = None

HTTP Method (GET/POST) that should be used to call the Answer URL.

PlivoClient

PlivoClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

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
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

make_call_async async

make_call_async(input: Call, auth_id: str) -> dict[str, Any] | None

Make a call

This operation is used to make a call.

list_messages_async async

list_messages_async(auth_id: str) -> dict[str, Any] | None

List all messages

This operation returns a list of all messages associated with your Plivo account.

send_sms_async async

send_sms_async(input: SMS, auth_id: str) -> dict[str, Any] | None

Send SMS

This operation is used to send a text message.

get_message_async async

get_message_async(auth_id: str, message_uuid: str) -> dict[str, Any] | None

Get message

This operation is used to fetch the details of a message, given the message ID.