TextrequestClient
Attributes
module-attribute
TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'TextingWebhook': {'operation_id': 'TextingWebhook', 'path': '/{connectionId}/dashboards/{dashboard_id}/hooks', 'method': 'post', 'required_parameters': ['dashboard_id', 'body'], 'callback_payload_type': 'TextingWebhookResponse'}}
Classes
dataclass
GetMessagesByContactPhoneResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Get a conversation's messages by a contact's phone number
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
SendMessageByPhoneNumberInput(*, body: Optional[str] = None, sender_name: Optional[str] = None, status_callback: Optional[str] = None, location_callback: Optional[str] = None, mms_media: Optional[List[str]] = None)
Send a message to the contact with the given phone number
Attributes
class-attribute
instance-attribute
Content of the message to send.
class-attribute
instance-attribute
The name of the message sender. This is shown in the TextRequest web app and api when retrieving this message.
class-attribute
instance-attribute
Url for the web app to hit with a POST command whenever this message's status goes from undelivered to sent (or error).
class-attribute
instance-attribute
Location callback url to hit with a POST command when the user accesses and approves sharing their location with the sender. To include the link, add [Location Request] to the message body. This callback is not required for location requests, but it can be useful for APIs.
class-attribute
instance-attribute
Array of MMS Media attachments for this message. Attachments must be urls gotten from the post /mms endpoint (not included in this connector). External attachment links will not be accepted.
dataclass
SendMessageByPhoneNumberResponse(*, message_id: Optional[str] = None, body: Optional[str] = None, message_direction: Optional[str] = None, response_by_username: Optional[str] = None, message_timestamp_utc: Optional[str] = None, delivery_status: Optional[str] = None, delivery_error: Optional[str] = None, mms_media: Optional[List[str]] = None)
Response for Send a message to the contact with the given phone number
Attributes
class-attribute
instance-attribute
Id of the message. This value is unique for each message.
class-attribute
instance-attribute
Content of this message.
class-attribute
instance-attribute
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively.
class-attribute
instance-attribute
Username of the Text Request user that last sent a message to this user.
class-attribute
instance-attribute
Timestamp of when the message was sent or received by Text Request.
class-attribute
instance-attribute
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'.
class-attribute
instance-attribute
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null.
dataclass
GetContactByPhoneNumberResponse(*, phone_number: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, display_name: Optional[str] = None, is_suppressed: Optional[bool] = None, is_archived: Optional[bool] = None, is_blocked: Optional[bool] = None, suppressed_reason: Optional[str] = None, note: Optional[str] = None, groups: Optional[List[int]] = None, contact_tags: Optional[List[str]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, is_resolved: Optional[bool] = None, first_contact_utc: Optional[str] = None, opted_out_utc: Optional[str] = None, last_msg_sent_utc: Optional[str] = None, last_msg_received_utc: Optional[str] = None, total_msgs_sent: Optional[int] = None, total_msgs_received: Optional[int] = None, response_count: Optional[int] = None, date_created_utc: Optional[str] = None, last_contact_date_utc: Optional[str] = None, last_message: Optional[Dict[str, Any]] = None)
Response for Gets the contact with the specified phone number
Attributes
class-attribute
instance-attribute
Phone number of this contact.
class-attribute
instance-attribute
First name of this contact.
class-attribute
instance-attribute
Last name of this contact.
class-attribute
instance-attribute
Full name of this contact. This is the default name displayed in the web app when viewing contacts.
class-attribute
instance-attribute
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received.
class-attribute
instance-attribute
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default).
class-attribute
instance-attribute
Whether the conversation with this contact are blocked, and therefore not received or stored.
class-attribute
instance-attribute
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null.
class-attribute
instance-attribute
Short phrase describing contact. Used for convenience. This is never shown to the contact.
class-attribute
instance-attribute
Array of integer ids referring to groups this contact belongs to.
class-attribute
instance-attribute
Array of guids referring to tags attached to this contact.
class-attribute
instance-attribute
Array of custom field ids and values defined for this contact.
class-attribute
instance-attribute
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false.
class-attribute
instance-attribute
Timestamp of when the first message was sent to this contact.
class-attribute
instance-attribute
Timestamp of when this contact opted out to receiving messages.
class-attribute
instance-attribute
Timestamp of when the last message was sent to this contact.
class-attribute
instance-attribute
Timestamp of when the last message was received from this contact.
class-attribute
instance-attribute
The number of total messages sent to this contact.
class-attribute
instance-attribute
The number of total messages received from this contact.
class-attribute
instance-attribute
The total number of response messages from the contact.
class-attribute
instance-attribute
The timestamp of when ths contact was created.
class-attribute
instance-attribute
The timestamp of when the last message was sent or received from this contact.
dataclass
CreateContactInput(*, first_name: Optional[str] = None, last_name: Optional[str] = None, display_name: Optional[str] = None, is_suppressed: Optional[bool] = None, is_archived: Optional[bool] = None, is_blocked: Optional[bool] = None, suppressed_reason: Optional[str] = None, note: Optional[str] = None, groups: Optional[List[int]] = None, contact_tags: Optional[List[str]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, is_resolved: Optional[bool] = None)
Create or update a contact
Attributes
class-attribute
instance-attribute
The new first name of the contact.
class-attribute
instance-attribute
The new last name of the contact.
class-attribute
instance-attribute
The new full name of the contact. This is the default name displayed in the web app when viewing contacts.
class-attribute
instance-attribute
Determines whether conversations with this contact are suppressed, and therefore not pushed to the top of the message queue when received.
class-attribute
instance-attribute
Determines whether conversations with this contact are archived, and therefore cannot be seen when querying conversations (by default).
class-attribute
instance-attribute
Determines whether conversations with this contact are blocked, and therefore not received or stored.
class-attribute
instance-attribute
Phrase describing the reason for suppressing contact.
class-attribute
instance-attribute
Short phrase describing contact. Used for convenience. This is never shown to the contact.
class-attribute
instance-attribute
Array of integer ids referring to groups this contact will belong to.
class-attribute
instance-attribute
Array of guids referring to tags attached to this contact.
class-attribute
instance-attribute
Array of custom field ids and values defined for this contact.
dataclass
CreateContactResponse(*, phone_number: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, display_name: Optional[str] = None, is_suppressed: Optional[bool] = None, is_archived: Optional[bool] = None, is_blocked: Optional[bool] = None, suppressed_reason: Optional[str] = None, note: Optional[str] = None, groups: Optional[List[int]] = None, contact_tags: Optional[List[str]] = None, custom_fields: Optional[List[Dict[str, Any]]] = None, is_resolved: Optional[bool] = None, first_contact_utc: Optional[str] = None, opted_out_utc: Optional[str] = None, last_msg_sent_utc: Optional[str] = None, last_msg_received_utc: Optional[str] = None, total_msgs_sent: Optional[int] = None, total_msgs_received: Optional[int] = None, response_count: Optional[int] = None, date_created_utc: Optional[str] = None, last_contact_date_utc: Optional[str] = None, last_message: Optional[Dict[str, Any]] = None)
Response for Create or update a contact
Attributes
class-attribute
instance-attribute
Phone number of this contact.
class-attribute
instance-attribute
First name of this contact.
class-attribute
instance-attribute
Last name of this contact.
class-attribute
instance-attribute
Full name of this contact. This is the default name displayed in the web app when viewing contacts.
class-attribute
instance-attribute
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received.
class-attribute
instance-attribute
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default).
class-attribute
instance-attribute
Whether the conversation with this contact are blocked, and therefore not received or stored.
class-attribute
instance-attribute
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null.
class-attribute
instance-attribute
Short phrase describing contact. Used for convenience. This is never shown to the contact.
class-attribute
instance-attribute
Array of integer ids referring to groups this contact belongs to.
class-attribute
instance-attribute
Array of guids referring to tags attached to this contact.
class-attribute
instance-attribute
Array of custom field ids and values defined for this contact.
class-attribute
instance-attribute
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false.
class-attribute
instance-attribute
Timestamp of when the first message was sent to this contact.
class-attribute
instance-attribute
Timestamp of when this contact opted out to receiving messages.
class-attribute
instance-attribute
Timestamp of when the last message was sent to this contact.
class-attribute
instance-attribute
Timestamp of when the last message was received from this contact.
class-attribute
instance-attribute
The number of total messages sent to this contact.
class-attribute
instance-attribute
The number of total messages received from this contact.
class-attribute
instance-attribute
Total number of response messages from the contact.
class-attribute
instance-attribute
Timestamp of when ths contact was created.
class-attribute
instance-attribute
Timestamp of when the last message was sent or received from this contact.
dataclass
GetContactsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Get all contacts that match the specified filtering criterion
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
GetGroupByIdResponse(*, id: Optional[int] = None, group_member_count: Optional[int] = None, is_keyword: Optional[bool] = None, name: Optional[str] = None, notes: Optional[str] = None, last_message_sent_utc: Optional[str] = None)
Response for Get a group by its id
Attributes
class-attribute
instance-attribute
The numerical id of the group.
class-attribute
instance-attribute
The number of members of the group.
class-attribute
instance-attribute
Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll.
class-attribute
instance-attribute
The name of this group.
class-attribute
instance-attribute
Any notes on this group.
dataclass
Updates a group with the given id
Attributes
class-attribute
instance-attribute
The new name of the group.
dataclass
UpdateGroupResponse(*, id: Optional[int] = None, group_member_count: Optional[int] = None, is_keyword: Optional[bool] = None, name: Optional[str] = None, notes: Optional[str] = None, last_message_sent_utc: Optional[str] = None)
Response for Updates a group with the given id
Attributes
class-attribute
instance-attribute
The numerical id of the group.
class-attribute
instance-attribute
The number of members of the group.
class-attribute
instance-attribute
Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll.
class-attribute
instance-attribute
The name of this group.
class-attribute
instance-attribute
Any notes on this group.
dataclass
GetGroupsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Gets all groups
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
Creates a new group
Attributes
class-attribute
instance-attribute
The new name of the group.
dataclass
CreateGroupResponse(*, id: Optional[int] = None, group_member_count: Optional[int] = None, is_keyword: Optional[bool] = None, name: Optional[str] = None, notes: Optional[str] = None, last_message_sent_utc: Optional[str] = None)
Response for Creates a new group
Attributes
class-attribute
instance-attribute
The numerical id of the group.
class-attribute
instance-attribute
The number of members of the group.
class-attribute
instance-attribute
Wheter this group is a keyword group. Such groups are autogenerated when a user sets up a keyword. Contacts are automatically added when they enroll.
class-attribute
instance-attribute
The name of this group.
class-attribute
instance-attribute
Any notes on this group.
dataclass
GetTagsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Gets all tags
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
GetPaymentResponse(*, payment_id: Optional[int] = None, request_date: Optional[str] = None, recipient: Optional[str] = None, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, is_past_due: Optional[bool] = None, reminder_was_sent: Optional[bool] = None, transaction_status: Optional[str] = None, textrequest_payment_status: Optional[str] = None, reference_number: Optional[str] = None)
Response for Gets the payment with the specified id
Attributes
class-attribute
instance-attribute
The numerical id of the payment.
class-attribute
instance-attribute
The timestamp of when this payment's initial message was queued to be sent.
class-attribute
instance-attribute
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number.
class-attribute
instance-attribute
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments.
class-attribute
instance-attribute
The phone number of the contact who is being sent this payment.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Whether this payment is past the request date.
class-attribute
instance-attribute
Whether a text reminder has already been sent for this payment.
class-attribute
instance-attribute
The status of the transaction in authvia. This value starts as Unknown.
class-attribute
instance-attribute
The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent.
class-attribute
instance-attribute
The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.
dataclass
MarkPaymentPaidResponse(*, payment_id: Optional[int] = None, request_date: Optional[str] = None, recipient: Optional[str] = None, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, is_past_due: Optional[bool] = None, reminder_was_sent: Optional[bool] = None, transaction_status: Optional[str] = None, textrequest_payment_status: Optional[str] = None, reference_number: Optional[str] = None)
Response for Mark a payment as paid
Attributes
class-attribute
instance-attribute
The numerical id of the payment.
class-attribute
instance-attribute
The timestamp of when this payment's initial message was queued to be sent.
class-attribute
instance-attribute
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number.
class-attribute
instance-attribute
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments.
class-attribute
instance-attribute
The phone number of the contact who is being sent this payment.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Whether this payment is past the request date.
class-attribute
instance-attribute
Whether a text reminder has already been sent for this payment.
class-attribute
instance-attribute
The status of the transaction in authvia. This value starts as Unknown.
class-attribute
instance-attribute
The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent.
class-attribute
instance-attribute
The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.
dataclass
SendPaymentReminderResponse(*, payment_id: Optional[int] = None, request_date: Optional[str] = None, recipient: Optional[str] = None, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, is_past_due: Optional[bool] = None, reminder_was_sent: Optional[bool] = None, transaction_status: Optional[str] = None, textrequest_payment_status: Optional[str] = None, reference_number: Optional[str] = None)
Response for Send a follow-up text reminding the user to pay the specified payment
Attributes
class-attribute
instance-attribute
The numerical id of the payment.
class-attribute
instance-attribute
The timestamp of when this payment's initial message was queued to be sent.
class-attribute
instance-attribute
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number.
class-attribute
instance-attribute
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments.
class-attribute
instance-attribute
The phone number of the contact who is being sent this payment.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Whether this payment is past the request date.
class-attribute
instance-attribute
Whether a text reminder has already been sent for this payment.
class-attribute
instance-attribute
The status of the transaction in authvia. This value starts as Unknown.
class-attribute
instance-attribute
The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent.
class-attribute
instance-attribute
The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.
dataclass
CancelPaymentResponse(*, payment_id: Optional[int] = None, request_date: Optional[str] = None, recipient: Optional[str] = None, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, is_past_due: Optional[bool] = None, reminder_was_sent: Optional[bool] = None, transaction_status: Optional[str] = None, textrequest_payment_status: Optional[str] = None, reference_number: Optional[str] = None)
Response for Cancels the specified payment
Attributes
class-attribute
instance-attribute
The numerical id of the payment.
class-attribute
instance-attribute
The timestamp of when this payment's initial message was queued to be sent.
class-attribute
instance-attribute
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number.
class-attribute
instance-attribute
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments.
class-attribute
instance-attribute
The phone number of the contact who is being sent this payment.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Whether this payment is past the request date.
class-attribute
instance-attribute
Whether a text reminder has already been sent for this payment.
class-attribute
instance-attribute
The status of the transaction in authvia. This value starts as Unknown.
class-attribute
instance-attribute
The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent.
class-attribute
instance-attribute
The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.
dataclass
GetPaymentsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Gets all payments
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
CreatePaymentInput(*, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, message: Optional[str] = None, reference_number: Optional[str] = None)
Creates a new payment
Attributes
class-attribute
instance-attribute
Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments.
class-attribute
instance-attribute
Phone number of the contact this payment will be sent to.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Message text to send to contact along with payment link.
dataclass
CreatePaymentResponse(*, payment_id: Optional[int] = None, request_date: Optional[str] = None, recipient: Optional[str] = None, description: Optional[str] = None, customer_phone: Optional[str] = None, amount_requested: Optional[float] = None, is_past_due: Optional[bool] = None, reminder_was_sent: Optional[bool] = None, transaction_status: Optional[str] = None, textrequest_payment_status: Optional[str] = None, reference_number: Optional[str] = None)
Response for Creates a new payment
Attributes
class-attribute
instance-attribute
The numerical id of the payment.
class-attribute
instance-attribute
The timestamp of when this payment's initial message was queued to be sent.
class-attribute
instance-attribute
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number.
class-attribute
instance-attribute
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments.
class-attribute
instance-attribute
The phone number of the contact who is being sent this payment.
class-attribute
instance-attribute
The amount in dollars requested by this payment.
class-attribute
instance-attribute
Whether this payment is past the request date.
class-attribute
instance-attribute
Whether a text reminder has already been sent for this payment.
class-attribute
instance-attribute
The status of the transaction in authvia. This value starts as Unknown.
class-attribute
instance-attribute
The status of the transaction in Text Request. This represents that status shown in the payments page on the Text Request app. It starts as Sent.
class-attribute
instance-attribute
The user-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference.
dataclass
GetDashboardResponse(*, id: Optional[int] = None, name: Optional[str] = None, phone: Optional[str] = None)
Response for Get info on this specific dashboard
Attributes
class-attribute
instance-attribute
The numerical id of the dashboard.
class-attribute
instance-attribute
The name of the dashboard.
dataclass
dataclass
UpdateDashboardsNameResponse(*, id: Optional[int] = None, name: Optional[str] = None, phone: Optional[str] = None)
Response for Update a specific dashboard's name
Attributes
class-attribute
instance-attribute
The numerical id of the dashboard.
class-attribute
instance-attribute
The name of the dashboard.
dataclass
GetConversationsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Gets all conversations for this dashboard
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
GetDashboardsResponse(*, meta: Optional[Dict[str, Any]] = None, items: Optional[List[Dict[str, Any]]] = None)
Response for Get all dashboards in an account
Attributes
class-attribute
instance-attribute
Metadata about the data returned by this request. This data is returned by all bulk GET requests.
dataclass
Create a new dashboard with the given name and phone number
Attributes
class-attribute
instance-attribute
The name of the dashboard.
dataclass
CreateDashboardResponse(*, id: Optional[int] = None, name: Optional[str] = None, phone: Optional[str] = None)
Response for Create a new dashboard with the given name and phone number
Attributes
class-attribute
instance-attribute
The numerical id of the dashboard.
class-attribute
instance-attribute
The name of the dashboard.
dataclass
dataclass
TextingWebhookResponse(*, id: Optional[int] = None, target_url: Optional[str] = None, event: Optional[str] = None)
Response for Triggers when a text is sent or received
Attributes
class-attribute
instance-attribute
The numerical id of the dashboard.
class-attribute
instance-attribute
The url the webhook will post to
TextrequestClient(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 textrequest connector.
Initialize a TextrequestClient.
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:
list_messages_by_contact_phone(dashboard_id: int, phone_number: str, page: int, page_size: int, *, 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]]
Get a conversation's messages by a contact's phone number
Get the conversation between the specified dashboard and phone number.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetMessagesByContactPhone.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the contact to get messages for. |
required |
page
|
int
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
required |
page_size
|
int
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
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_message_by_phone_number(input: SendMessageByPhoneNumberInput | Mapping[str, Any], dashboard_id: int, phone_number: 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 a message to the contact with the given phone number
Sends a message (starting a new conversation if the given phone number has no message history).
Swagger operation ID: SendMessageByPhoneNumber.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
SendMessageByPhoneNumberInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the contact to send a message to. |
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
archive_conversation(dashboard_id: int, phone_number: 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
Archive a Conversation
Archives a conversation, removing it from the results of all conversation retrieval endpoints. A conversation will be automatically unarchived if the customer sends a text to your Text Request number, or if you send the customer a text from your Text Request number. Archiving conversations is a good way to remove clutter from customers you don't plan on talking to in the future. Note that if a customer texts in "STOP" to prevent you from sending them any further SMS messages, the conversation is automatically archived.
Swagger operation ID: ArchiveConversation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the conversation to archive. |
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
unarchive_conversation(dashboard_id: int, phone_number: 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
Unarchive a Conversation
Unarchives a conversation. Once a conversation is unarchived, it will once again appear in the queue. it will also appear in conversations returned by the /conversations endpoint. If a conversation is already unarchived, this method has no effect.
Swagger operation ID: UnarchiveConversation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the conversation to archive. |
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_contact_by_phone_number(dashboard_id: int, phone_number: 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
Gets the contact with the specified phone number
Gets the contact with the specified phone number
Swagger operation ID: GetContactByPhoneNumber.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the contact to get. |
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
delete_contact(dashboard_id: int, phone_number: 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
Deletes the contact with the specified phone number
Deletes the contact with the specified phone number
Swagger operation ID: DeleteContact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the contact to delete. |
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
create_contact(input: CreateContactInput | Mapping[str, Any], dashboard_id: int, phone_number: 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
Create or update a contact
Creates or updates a contact (depending on whether one already exists with the given phone number).
Swagger operation ID: CreateContact.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateContactInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
phone_number
|
str
|
Phone number of the contact to create or update. |
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_contacts(dashboard_id: int, page: int, page_size: int, *, contact_phone_number: Optional[str] = None, last_message_timestamp_before_utc: Optional[str] = None, last_message_timestamp_after_utc: Optional[str] = None, contact_created_before: Optional[str] = None, contact_created_after: Optional[str] = None, is_resolved: Optional[bool] = None, is_blocked: Optional[bool] = None, is_archived: Optional[bool] = None, is_suppressed: Optional[bool] = None, has_opted_out: Optional[bool] = None, last_message_sent_before: Optional[str] = None, last_message_sent_after: Optional[str] = None, last_message_received_before: Optional[str] = None, last_message_received_after: Optional[str] = None, tags: Optional[str] = None, groups: Optional[str] = None, custom_field_id1: Optional[str] = None, custom_field_value1: Optional[str] = None, custom_field_id2: Optional[str] = None, custom_field_value2: Optional[str] = None, custom_field_id3: Optional[str] = None, custom_field_value3: Optional[str] = None, 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]]
Get all contacts that match the specified filtering criterion
Gets all contacts that match the specified filtering criterion. Only the dashboard specified will be searched; there is no account level search for a number available.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetContacts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
page
|
int
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
required |
page_size
|
int
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
required |
contact_phone_number
|
Optional[str]
|
Phone number to filter contacts by. |
None
|
last_message_timestamp_before_utc
|
Optional[str]
|
Cutoff time for searching contacts by the last message sent or received. No contacts who sent messages after this time will be shown. |
None
|
last_message_timestamp_after_utc
|
Optional[str]
|
Cutoff time for searching contacts by the last message sent or received. No contacts whose last sent message is before this time will be shown. |
None
|
contact_created_before
|
Optional[str]
|
Cutoff time for searching contacts by when they were created. No contacts created after this time will be shown. |
None
|
contact_created_after
|
Optional[str]
|
Cutoff time for searching contacts by when they were created. No contacts created before this time will be shown. |
None
|
is_resolved
|
Optional[bool]
|
Whether to search for contacts whose conversations have been resolved. |
None
|
is_blocked
|
Optional[bool]
|
Whether to search for contacts who have been blocked. |
None
|
is_archived
|
Optional[bool]
|
Whether to search for contacts who have been archived. |
None
|
is_suppressed
|
Optional[bool]
|
Whether to search for contacts who have been suppressed. |
None
|
has_opted_out
|
Optional[bool]
|
Whether to search for contacts who have opted out of receiving texts. |
None
|
last_message_sent_before
|
Optional[str]
|
Cutoff time for searching contacts by when the last message was sent to the customer. No contacts who sent messages after this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc. |
None
|
last_message_sent_after
|
Optional[str]
|
Cutoff time for searching contacts by when the last message was sent to the customer. No contacts whose last sent message is before this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_after_utc. |
None
|
last_message_received_before
|
Optional[str]
|
Cutoff time for searching contacts by the last message received from the customer. No contacts who received messages after this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc. |
None
|
last_message_received_after
|
Optional[str]
|
Cutoff time for searching contacts by the last message received from the customer. No contacts whose last sent message is before this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc. |
None
|
tags
|
Optional[str]
|
Comma-separated list of guids referring to tags to filter contacts by. |
None
|
groups
|
Optional[str]
|
Comma-separated list of integer ids referring to groups to filter contacts by. |
None
|
custom_field_id1
|
Optional[str]
|
Guid referring to custom field to filter contacts by. |
None
|
custom_field_value1
|
Optional[str]
|
Value referring to custom field to filter contacts by. |
None
|
custom_field_id2
|
Optional[str]
|
Guid referring to second custom field to filter contacts by. |
None
|
custom_field_value2
|
Optional[str]
|
Value referring to second custom field to filter contacts by. |
None
|
custom_field_id3
|
Optional[str]
|
Guid referring to third custom field to filter contacts by. |
None
|
custom_field_value3
|
Optional[str]
|
Value referring to third custom field to filter contacts by. |
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 |
|---|---|
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
bulk_update_contacts(input: BulkUpdateContactsInput, dashboard_id: int, *, 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
Bulk update contacts
Only the dashboard specified will have contacts added; contacts are organized by dashboard, and there is no account level search for a number available.
Swagger operation ID: BulkUpdateContacts.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
BulkUpdateContactsInput
|
The request body. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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_group_by_id(dashboard_id: int, group_id: int, *, 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 a group by its id
Gets the group with the specified id.
Swagger operation ID: GetGroupById.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
group_id
|
int
|
The numerical id of the group to get. |
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
delete_group(dashboard_id: int, group_id: int, *, 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
Deletes the group with the specified id
Deletes the group with the specified id. This will succeed even if there are contacts that are members of the group (the contacts will not be deleted).
Swagger operation ID: DeleteGroup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
group_id
|
int
|
The numerical id of the group to delete. |
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
update_group(input: UpdateGroupInput | Mapping[str, Any], dashboard_id: int, group_id: int, *, 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
Updates a group with the given id
Updates a group's name using the group's numerical id. If the passed in group id does not exist, the call will fail.
Swagger operation ID: UpdateGroup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateGroupInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
group_id
|
int
|
The numerical id of the group to update. |
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_groups(dashboard_id: int, page: int, page_size: int, *, 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]]
Gets all groups
Gets all groups for the user's account.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetGroups.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
page
|
int
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
required |
page_size
|
int
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
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
create_group(input: CreateGroupInput | Mapping[str, Any], dashboard_id: int, *, 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
Creates a new group
Creates a new group with the provided name.
Swagger operation ID: CreateGroup.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateGroupInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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_tags(dashboard_id: int, page: int, page_size: int, *, 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]]
Gets all tags
Gets all the tags for this dashboard. Tags are unique between dashboards.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetTags.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
page
|
int
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
required |
page_size
|
int
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
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. |
list_custom_fields(dashboard_id: int, *, 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]]
Gets all custom fields
Gets all custom fields for this dashboard. Custom fields are unique between dashboards.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetCustomFields.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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
get_payment(dashboard_id: int, payment_id: int, *, 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
Gets the payment with the specified id
Gets the payment with the specified id.
Swagger operation ID: GetPayment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
payment_id
|
int
|
The numerical id of the payment to get. |
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
mark_payment_paid(dashboard_id: int, payment_id: int, *, 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
Mark a payment as paid
Closes a payment as "paid". Use this endpoint for when the payment is paid through a means other than the payment request portal. This will close the payment and add its payment amount to your statistics. This endpoint is not required for payments paid through the payments-portal sent through Text Request; that will automatically mark a payment as paid.
Swagger operation ID: MarkPaymentPaid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
payment_id
|
int
|
The numerical id of the payment to update. |
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
send_payment_reminder(dashboard_id: int, payment_id: int, *, 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 a follow-up text reminding the user to pay the specified payment
Sends a reminder to the contact to pay the specified payment. The content of the message is auto-generated. To avoid spam, only one reminder can be sent per payment
Swagger operation ID: SendPaymentReminder.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
payment_id
|
int
|
The numerical id of the payment to update. |
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
cancel_payment(dashboard_id: int, payment_id: int, *, 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
Cancels the specified payment
Cancels the specified payment, texting the user that the payment has been canceled. Payments cannot be edited, so canceling and issuing a new payment is the best way to correct a payment.
Swagger operation ID: CancelPayment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
payment_id
|
int
|
The numerical id of the payment to update. |
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_payments(dashboard_id: int, page: int, page_size: int, *, reference_number: Optional[str] = None, phone_number: Optional[str] = None, sort_type: Optional[str] = None, sort_direction: Optional[str] = None, 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]]
Gets all payments
Gets all payments, including canceled and paid payments. These can be filtered using the query parameters.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetPayments.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
page
|
int
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
required |
page_size
|
int
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
required |
reference_number
|
Optional[str]
|
User-defined id defined when payments are created that can be used to quickly find payments. Reference numbers are not unique; many payments can have the same reference. |
None
|
phone_number
|
Optional[str]
|
Phone number of the contact this payment was sent to. |
None
|
sort_type
|
Optional[str]
|
Property to sort payments by. Can be "amount", "contact", "date", "status". |
None
|
sort_direction
|
Optional[str]
|
Direction to sort payments in. Can be "desc" for greatest to smallest, or "asc" for smallest to greatest. |
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 |
|---|---|
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
create_payment(input: CreatePaymentInput | Mapping[str, Any], dashboard_id: int, *, 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
Creates a new payment
Creates a new payment with the provided message to the provided contact.
Swagger operation ID: CreatePayment.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreatePaymentInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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_dashboard(dashboard_id: int, *, 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 info on this specific dashboard
Returns the name and phone of the dashboard.
Swagger operation ID: GetDashboard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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
delete_dashboard(dashboard_id: int, *, 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
Deletes the specified dashboard
Deletes the specified dashboard.
Swagger operation ID: DeleteDashboard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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
update_dashboards_name(input: UpdateDashboardsNameInput | Mapping[str, Any], dashboard_id: int, *, 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
Update a specific dashboard's name
Updates a dashboard. This does not change a dashboard's phone number. If you want a new number with another dashboard's contacts, you will have to create a new dashboard with a POST and add the contacts with a bulk export/import.
Swagger operation ID: UpdateDashboardsName.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateDashboardsNameInput | Mapping[str, Any]
|
The request body. Mapping keys use serialized Swagger wire names. |
required |
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
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_conversations(dashboard_id: int, *, tags: Optional[str] = None, show_unresolved_only: Optional[str] = None, include_archived: Optional[str] = None, search: Optional[str] = None, page: Optional[int] = None, page_size: Optional[int] = None, 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]]
Gets all conversations for this dashboard
Gets all conversations for this dashboard, and includes info on the last message for each conversation.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetConversations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dashboard_id
|
int
|
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
required |
tags
|
Optional[str]
|
Comma-separated list of guids referring to tags to filter conversations by. |
None
|
show_unresolved_only
|
Optional[str]
|
Whether to only search for contacts whose conversations have been resolved. If this is false, both resolved and unresolved conversations will be shown. |
None
|
include_archived
|
Optional[str]
|
Whether to include conversations with contacts that have been archived. |
None
|
search
|
Optional[str]
|
Search term for filtering conversations by phone number or display name. If the search term is less than a full name or phone number, the search will return all conversations that partially match it. |
None
|
page
|
Optional[int]
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
None
|
page_size
|
Optional[int]
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
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 |
|---|---|
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. |
list_dashboards(*, page: Optional[int] = None, page_size: Optional[int] = None, 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]]
Get all dashboards in an account
Gets all dashboards in an account.
Returns a single-page Azure Core async collection.
Swagger operation ID: GetDashboards.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
page
|
Optional[int]
|
The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned. |
None
|
page_size
|
Optional[int]
|
The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter. |
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 |
|---|---|
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
create_dashboard(input: CreateDashboardInput | 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
Create a new dashboard with the given name and phone number
Creates a new dashboard in the account. Once the dashboard is created, admins will be emailed about the change and can begin assigning users. This endpoint can make a dashboard for any provisioned numbers. You can search for provisioned numbers in a specific area code using GET /dashboards/provisioning. If the phone number is already in use, a Bad Request exception will be thrown.
Swagger operation ID: CreateDashboard.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDashboardInput | 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. |