Text Request
Text Request is a business texting platform that helps businesses turn conversations into customers.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Text Request API Support |
| URL | https://www.textrequest.com/contact |
| [email protected] |
| Connector Metadata | |
|---|---|
| Publisher | Text Request |
| Website | https://www.textrequest.com/ |
| Privacy policy | https://www.textrequest.com/privacy-policy/ |
| Categories | Communication;Sales and CRM |
Text Request is a business texting solution, helping you connect to customers, drive engagement, and turn customers into sales. With Text Request, you can organize business texting into separate phone lines and begin marketting to customers quickly and efficiently.
Prerequisites
This connector requires a Text Request account with API access. For more information, visit our website.
How to get credentials
To use this integration, you need to get the API Key from your Text Request. To see if your Text Request plan has API Access, visit the plans breakdown. If you have a plan that does not have API Access, you can add it as an add-on feature for 50$/month.
- Sign in to your Text Request account
- Click on the Integrations page on your navigation sidebar on the left
- Find the API tile. If the links on it say "Add Now", you do not have a plan with API Access. You can click on the "Add Now" link to add it. Otherwise, click on the link for "API Key and Webhooks"
- Find the API Key and copy it. This key is all you need to authorize your connection
Get started with your connector
Once you select this connection in Power Automate to connect, you will be asked to enter your API Key. After that you can use the connection to send text messages and update contact information in Text Request whenever a trigger is set off in your other connections. You can create an automation to trigger when a customer signs on in Hubspot, to send them an initial text, or place them in a special group. You can connect with Survey Monkey to add contacts to Text Request when they submit a form.
Known issues and limitations
There are some calls in the Text Request API not included in this connector. Specifically, using Text Request's webhooks as flow triggers is not included. You can visit your Text Request account and go to the same place as you got your API Key to add webhooks to your account; however, they won't be able to activate any automations. For any API calls that aren't included, you can access the API Documentation here and create calls to any unused calls with Power Automate's HTTP action.
Common errors and remedies
If you get a 404 error on any of your requests, double-check the dashboard Id getting passed in. You can use the GetDashboards action to see a list of your dashboards and their ids.
If you are getting contacts or any other value, you may notice some yes/no values which are automatically filled. These values are not required, but are included by default to make sure invalid answers aren't included. To get all contacts, regardless of if they're suppressed, archived, blocked, or opted-out, remove the default "No" value from that field.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Archive a Conversation |
Archiving a conversation removes 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. |
| 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. |
| 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. |
| 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. |
| Create or update a contact |
Creates or updates a contact (depending on whether one already exists with the given phone number). |
| Creates a new group |
Creates a new group with the provided name. |
| Creates a new payment |
Creates a new payment with the provided message to the provided contact. |
| Deletes the contact with the specified phone number |
If a contact does not exist with this phone number in this dashboard, no content will be returned. If a contact does exist, but has no message history, no content will be returned, and a successful status code will indicate it was deleted. If a contact has any message history, it cannot be deleted, then a Bad Request error will be returned. |
| 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). |
| Deletes the specified dashboard |
Deletes the specified dashboard. |
| Get a conversation's messages by a contact's phone number |
Retrieves the conversation between the specified dashboard and phone number. |
| Get all dashboards in an account |
Returns all dashboards in an account. |
| Get info on this specific dashboard |
Returns the name and phone of the dashboard. |
| 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. |
| Retrieves a group by its id |
Retrieves the group with the specified id. |
| Retrieves all contacts that match the specified filtering criterion |
Retrieves 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. |
| Retrieves all conversations for this dashboard |
Retrieves all conversations for this dashboard, and includes info on the last message for each conversation. |
| Retrieves all custom fields |
Retrieves all custom fields for this dashboard. Custom fields are unique between dashboards. |
| Retrieves all groups |
Retrieves all groups for the user's account. |
| Retrieves all payments |
Retrieves all payments, including canceled and paid payments. These can be filtered using the query parameters. |
| Retrieves all tags |
Retrieves all the tags for this dashboard. Tags are unique between dashboards. |
| Retrieves the contact with the specified phone number |
If a contact does not yet exist with this phone number in this dashboard, no content will be returned, and no error will be thrown. Only the dashboard specified will be searched; contacts are organized by dashboard, and there is no account level search for a number available. |
| Retrieves the payment with the specified id |
Retrieves the payment with the specified id. |
| 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 |
| 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). |
| Unarchive a Conversation |
Unarchive 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. |
| 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. |
| 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. |
Archive a Conversation
Archiving a conversation removes 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of conversation
|
phone_number | True | string |
Phone number of the conversation to archive. |
Returns
- response
- string
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of contact
|
phone_number | string |
Phone number of the contact to create or update. |
|
|
First name of contact
|
first_name | string |
The new first name of the contact. |
|
|
Last name of contact
|
last_name | string |
The new last name of the contact. |
|
|
Full name of contact
|
display_name | string |
The new full name of the contact. This is the default name displayed in the web app when viewing contacts. |
|
|
Whether messages from this contact are suppressed
|
is_suppressed | boolean |
Determines whether conversations with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
|
Whether messages from this contact are archived
|
is_archived | boolean |
Determines whether conversations with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
|
Whether messages from this contact are blocked
|
is_blocked | boolean |
Determines whether conversations with this contact are blocked, and therefore not received or stored. |
|
|
Reason for suppressing this contact
|
suppressed_reason | string |
Phrase describing the reason for suppressing contact. |
|
|
Contact note
|
note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
|
Contact groups
|
groups | array of integer |
Array of integer ids referring to groups this contact will belong to. |
|
|
Contact tags
|
contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
|
Custom field id
|
id | string |
Guid referring to a custom field. |
|
|
Custom field value
|
value | string |
This contact's value for this custom field. |
|
|
Whether the current conversation with this contact has been resolved
|
is_resolved | boolean |
Determines whether the current conversation with this contact is resolved. Any new texts received by this contact will set this false. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
phone_number
|
phone_number | string |
Phone number of this contact. |
|
first_name
|
first_name | string |
First name of this contact. |
|
last_name
|
last_name | string |
Last name of this contact. |
|
display_name
|
display_name | string |
Full name of this contact. This is the default name displayed in the web app when viewing contacts. |
|
is_suppressed
|
is_suppressed | boolean |
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
is_archived
|
is_archived | boolean |
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
is_blocked
|
is_blocked | boolean |
Whether the conversation with this contact are blocked, and therefore not received or stored. |
|
suppressed_reason
|
suppressed_reason | string |
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. |
|
note
|
note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
groups
|
groups | array of integer |
Array of integer ids referring to groups this contact belongs to. |
|
contact_tags
|
contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
custom_fields
|
custom_fields | array of object |
Array of custom field ids and values defined for this contact. |
|
id
|
custom_fields.id | string |
Guid referring to a custom field. |
|
value
|
custom_fields.value | string |
This contact's value for this custom field. |
|
is_resolved
|
is_resolved | boolean |
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. |
|
first_contact_utc
|
first_contact_utc | string |
Timestamp of when the first message was sent to this contact. |
|
opted_out_utc
|
opted_out_utc | string |
Timestamp of when this contact opted out to receiving messages. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Timestamp of when the last message was sent to this contact. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Timestamp of when the last message was received from this contact. |
|
total_msgs_sent
|
total_msgs_sent | integer |
The number of total messages sent to this contact. |
|
total_msgs_received
|
total_msgs_received | integer |
The number of total messages received from this contact. |
|
response_count
|
response_count | integer |
Total number of response messages from the contact. |
|
date_created_utc
|
date_created_utc | string |
Timestamp of when ths contact was created. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
Timestamp of when the last message was sent or received from this contact. |
|
message_id
|
last_message.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
last_message.body | string |
Content of this message. |
|
message_direction
|
last_message.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
last_message.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
last_message.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
last_message.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the payment
|
payment_id | True | integer |
The numerical id of the payment to update. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
The numerical id of the payment. |
|
request_date
|
request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
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. |
|
reference_number
|
reference_number | string |
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. |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
name
|
name | string |
The name of the dashboard. |
|
|
phone
|
phone | string |
The texting number associated with this dashboard. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the dashboard. |
|
name
|
name | string |
The name of the dashboard. |
|
phone
|
phone | string |
The texting number associated with this dashboard. |
Create or update a contact
Creates or updates a contact (depending on whether one already exists with the given phone number).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of contact
|
phone_number | True | string |
Phone number of the contact to create or update. |
|
First name of contact
|
first_name | string |
The new first name of the contact. |
|
|
Last name of contact
|
last_name | string |
The new last name of the contact. |
|
|
Full name of contact
|
display_name | string |
The new full name of the contact. This is the default name displayed in the web app when viewing contacts. |
|
|
Whether messages from this contact are suppressed
|
is_suppressed | boolean |
Determines whether conversations with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
|
Whether messages from this contact are archived
|
is_archived | boolean |
Determines whether conversations with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
|
Whether messages from this contact are blocked
|
is_blocked | boolean |
Determines whether conversations with this contact are blocked, and therefore not received or stored. |
|
|
Reason for suppressing this contact
|
suppressed_reason | string |
Phrase describing the reason for suppressing contact. |
|
|
Contact Note
|
note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
|
Contact Groups
|
groups | array of integer |
Array of integer ids referring to groups this contact will belong to. |
|
|
Contact Tags
|
contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
|
Custom field id
|
id | string |
Guid referring to a custom field. |
|
|
Custom field value
|
value | string |
This contact's value for this custom field. |
|
|
Whether the current conversation with this contact has been resolved
|
is_resolved | boolean |
Determines whether the current conversation with this contact is resolved. Any new texts received by this contact will set this false. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
phone_number
|
phone_number | string |
Phone number of this contact. |
|
first_name
|
first_name | string |
First name of this contact. |
|
last_name
|
last_name | string |
Last name of this contact. |
|
display_name
|
display_name | string |
Full name of this contact. This is the default name displayed in the web app when viewing contacts. |
|
is_suppressed
|
is_suppressed | boolean |
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
is_archived
|
is_archived | boolean |
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
is_blocked
|
is_blocked | boolean |
Whether the conversation with this contact are blocked, and therefore not received or stored. |
|
suppressed_reason
|
suppressed_reason | string |
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. |
|
note
|
note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
groups
|
groups | array of integer |
Array of integer ids referring to groups this contact belongs to. |
|
contact_tags
|
contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
custom_fields
|
custom_fields | array of object |
Array of custom field ids and values defined for this contact. |
|
id
|
custom_fields.id | string |
Guid referring to a custom field. |
|
value
|
custom_fields.value | string |
This contact's value for this custom field. |
|
is_resolved
|
is_resolved | boolean |
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. |
|
first_contact_utc
|
first_contact_utc | string |
Timestamp of when the first message was sent to this contact. |
|
opted_out_utc
|
opted_out_utc | string |
Timestamp of when this contact opted out to receiving messages. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Timestamp of when the last message was sent to this contact. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Timestamp of when the last message was received from this contact. |
|
total_msgs_sent
|
total_msgs_sent | integer |
The number of total messages sent to this contact. |
|
total_msgs_received
|
total_msgs_received | integer |
The number of total messages received from this contact. |
|
response_count
|
response_count | integer |
Total number of response messages from the contact. |
|
date_created_utc
|
date_created_utc | string |
Timestamp of when ths contact was created. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
Timestamp of when the last message was sent or received from this contact. |
|
message_id
|
last_message.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
last_message.body | string |
Content of this message. |
|
message_direction
|
last_message.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
last_message.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
last_message.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
last_message.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Creates a new group
Creates a new group with the provided name.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Group name
|
name | string |
The new name of the group. |
|
|
Group note
|
notes | string |
Short phrase describing group. Used for convenience. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the group. |
|
group_member_count
|
group_member_count | integer |
The number of members of the group. |
|
is_keyword
|
is_keyword | boolean |
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. |
|
name
|
name | string |
The name of this group. |
|
notes
|
notes | string |
Any notes on this group. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Timestamp of when the last group message was sent for this group. |
Creates a new payment
Creates a new payment with the provided message to the provided contact.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Payment description
|
description | string |
Description of the payment. Description is not shown to the contact and is only used by internal users for context about payments. |
|
|
Recipient phone number
|
customer_phone | string |
Phone number of the contact this payment will be sent to. |
|
|
Amount requested in dollars
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
|
Payment message text body
|
message | string |
Message text to send to contact along with payment link. |
|
|
Reference string of the payment
|
reference_number | string |
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. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
The numerical id of the payment. |
|
request_date
|
request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
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. |
|
reference_number
|
reference_number | string |
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. |
Deletes the contact with the specified phone number
If a contact does not exist with this phone number in this dashboard, no content will be returned. If a contact does exist, but has no message history, no content will be returned, and a successful status code will indicate it was deleted. If a contact has any message history, it cannot be deleted, then a Bad Request error will be returned.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of contact
|
phone_number | True | string |
Phone number of the contact to delete. |
Returns
- response
- string
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).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the group
|
group_id | True | integer |
The numerical id of the group to delete. |
Returns
- response
- string
Deletes the specified dashboard
Deletes the specified dashboard.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
- response
- string
Get a conversation's messages by a contact's phone number
Retrieves the conversation between the specified dashboard and phone number.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Contact's phone number to search by
|
phone_number | True | string |
Phone number of the contact to get messages for. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of message entities gotten from Text Request. |
|
message_id
|
items.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
items.body | string |
Content of this message. |
|
message_direction
|
items.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
items.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
items.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
items.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
items.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
items.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Get all dashboards in an account
Returns all dashboards in an account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of dashboard entities gotten from Text Request. |
|
id
|
items.id | integer |
The numerical id of the dashboard. |
|
name
|
items.name | string |
The name of the dashboard. |
|
phone
|
items.phone | string |
The texting number associated with this dashboard. |
Get info on this specific dashboard
Returns the name and phone of the dashboard.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the dashboard. |
|
name
|
name | string |
The name of the dashboard. |
|
phone
|
phone | string |
The texting number associated with this dashboard. |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the payment
|
payment_id | True | integer |
The numerical id of the payment to update. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
The numerical id of the payment. |
|
request_date
|
request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
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. |
|
reference_number
|
reference_number | string |
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. |
Retrieves a group by its id
Retrieves the group with the specified id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the group
|
group_id | True | integer |
The numerical id of the group to get. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the group. |
|
group_member_count
|
group_member_count | integer |
The number of members of the group. |
|
is_keyword
|
is_keyword | boolean |
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. |
|
name
|
name | string |
The name of this group. |
|
notes
|
notes | string |
Any notes on this group. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Timestamp of when the last group message was sent for this group. |
Retrieves all contacts that match the specified filtering criterion
Retrieves 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact's phone number to search by
|
contact_phone_number | string |
Phone number to filter contacts by. |
|
|
'Last-message-time sent before' search timestamp in UTC time
|
last_message_timestamp_before_utc | date-time |
Cutoff time for searching contacts by the last message sent or received. No contacts who sent messages after this time will be shown. |
|
|
'Last-message-time sent after' search timestamp in UTC time
|
last_message_timestamp_after_utc | date-time |
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. |
|
|
'Created before' search timestamp
|
contact_created_before | date-time |
Cutoff time for searching contacts by when they were created. No contacts created after this time will be shown. |
|
|
'Created after' search timestamp
|
contact_created_after | date-time |
Cutoff time for searching contacts by when they were created. No contacts created before this time will be shown. |
|
|
Whether contact's conversation is resolved
|
is_resolved | boolean |
Whether to search for contacts whose conversations have been resolved. |
|
|
Whether contact is blocked
|
is_blocked | boolean |
Whether to search for contacts who have been blocked. |
|
|
Whether contact is archived
|
is_archived | boolean |
Whether to search for contacts who have been archived. |
|
|
Whether contact is suppressed
|
is_suppressed | boolean |
Whether to search for contacts who have been suppressed. |
|
|
Whether contact has opted out
|
has_opted_out | boolean |
Whether to search for contacts who have opted out of receiving texts. |
|
|
'Last-message-time sent before' search timestamp
|
last_message_sent_before | date-time |
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 |
|
|
'Last-message-time sent after' search timestamp
|
last_message_sent_after | date-time |
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 |
|
|
'Last-message-time received before' search timestamp
|
last_message_received_before | date-time |
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 |
|
|
'Last-message-time received after' search timestamp
|
last_message_received_after | date-time |
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 |
|
|
Contact Tags
|
tags | string |
Comma-separated list of guids referring to tags to filter contacts by. |
|
|
Contact Groups
|
groups | string |
Comma-separated list of integer ids referring to groups to filter contacts by. |
|
|
Id of custom field to filter by
|
custom_field_id_1 | string |
Guid referring to custom field to filter contacts by. |
|
|
Value of custom field to filter by
|
custom_field_value_1 | string |
Value referring to custom field to filter contacts by. |
|
|
Id of second custom field to filter by
|
custom_field_id_2 | string |
Guid referring to second custom field to filter contacts by. |
|
|
Value of second custom field to filter by
|
custom_field_value_2 | string |
Value referring to second custom field to filter contacts by. |
|
|
Id of third custom field to filter by
|
custom_field_id_3 | string |
Guid referring to third custom field to filter contacts by. |
|
|
Value of third custom field to filter by
|
custom_field_value_3 | string |
Value referring to third custom field to filter contacts by. |
|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of contact entities gotten from Text Request. |
|
phone_number
|
items.phone_number | string |
Phone number of this contact. |
|
first_name
|
items.first_name | string |
First name of this contact. |
|
last_name
|
items.last_name | string |
Last name of this contact. |
|
display_name
|
items.display_name | string |
Full name of this contact. This is the default name displayed in the web app when viewing contacts. |
|
is_suppressed
|
items.is_suppressed | boolean |
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
is_archived
|
items.is_archived | boolean |
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
is_blocked
|
items.is_blocked | boolean |
Whether the conversation with this contact are blocked, and therefore not received or stored. |
|
suppressed_reason
|
items.suppressed_reason | string |
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. |
|
note
|
items.note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
groups
|
items.groups | array of integer |
Array of integer ids referring to groups this contact belongs to. |
|
contact_tags
|
items.contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
custom_fields
|
items.custom_fields | array of object |
Array of custom field ids and values defined for this contact. |
|
id
|
items.custom_fields.id | string |
Guid referring to a custom field. |
|
value
|
items.custom_fields.value | string |
This contact's value for this custom field. |
|
is_resolved
|
items.is_resolved | boolean |
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. |
|
first_contact_utc
|
items.first_contact_utc | string |
Timestamp of when the first message was sent to this contact. |
|
opted_out_utc
|
items.opted_out_utc | string |
Timestamp of when this contact opted out to receiving messages. |
|
last_msg_sent_utc
|
items.last_msg_sent_utc | string |
Timestamp of when the last message was sent to this contact. |
|
last_msg_received_utc
|
items.last_msg_received_utc | string |
Timestamp of when the last message was received from this contact. |
|
total_msgs_sent
|
items.total_msgs_sent | integer |
The number of total messages sent to this contact. |
|
total_msgs_received
|
items.total_msgs_received | integer |
The number of total messages received from this contact. |
|
response_count
|
items.response_count | integer |
Total number of response messages from the contact. |
|
date_created_utc
|
items.date_created_utc | string |
Timestamp of when ths contact was created. |
|
last_contact_date_utc
|
items.last_contact_date_utc | string |
Timestamp of when the last message was sent or received from this contact. |
|
message_id
|
items.last_message.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
items.last_message.body | string |
Content of this message. |
|
message_direction
|
items.last_message.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
items.last_message.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
items.last_message.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
items.last_message.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
items.last_message.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Retrieves all conversations for this dashboard
Retrieves all conversations for this dashboard, and includes info on the last message for each conversation.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Tags
|
tags | string |
Comma-separated list of guids referring to tags to filter conversations by. |
|
|
Whether to show only resolved conversations
|
show_unresolved_only | string |
Whether to only search for contacts whose conversations have been resolved. If this is false, both resolved and unresolved conversations will be shown. |
|
|
Whether to include archived conversations
|
include_archived | string |
Whether to include conversations with contacts that have been archived. |
|
|
Term to filter by for phone numbers and contact name
|
search | string |
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. |
|
|
Number page to get
|
page | integer |
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. |
|
|
Amount of each entity to get per page
|
page_size | integer |
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. |
|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of conversation entities gotten from Text Request. |
|
phone_number
|
items.phone_number | string |
The contact's phone number. |
|
message_id
|
items.last_message.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
items.last_message.body | string |
Content of this message. |
|
message_direction
|
items.last_message.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
items.last_message.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
items.last_message.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
items.last_message.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
items.last_message.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
items.last_message.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Retrieves all custom fields
Retrieves all custom fields for this dashboard. Custom fields are unique between dashboards.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
The numerical id of the field. |
|
name
|
name | string |
The name of the custom field. |
Retrieves all groups
Retrieves all groups for the user's account.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of group entities gotten from Text Request. |
|
id
|
items.id | integer |
The numerical id of the group. |
|
group_member_count
|
items.group_member_count | integer |
The number of members of the group. |
|
is_keyword
|
items.is_keyword | boolean |
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. |
|
name
|
items.name | string |
The name of this group. |
|
notes
|
items.notes | string |
Any notes on this group. |
|
last_message_sent_utc
|
items.last_message_sent_utc | string |
The timestamp of when the last group message was sent for this group. |
Retrieves all payments
Retrieves all payments, including canceled and paid payments. These can be filtered using the query parameters.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Reference string of the payment
|
reference_number | string |
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. |
|
|
Payment phone number
|
phone_number | string |
Phone number of the contact this payment was sent to. |
|
|
Sort-by
|
sort_type | string |
Property to sort payments by. Can be "amount", "contact", "date", "status". |
|
|
Sort direction
|
sort_direction | string |
Direction to sort payments in. Can be "desc" for greatest to smallest, or "asc" for smallest to greatest. |
|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of payment entities gotten from Text Request. |
|
payment_id
|
items.payment_id | integer |
The numerical id of the payment. |
|
request_date
|
items.request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
items.recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
items.description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
items.customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
items.amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
items.is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
items.reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
items.transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
items.textrequest_payment_status | string |
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. |
|
reference_number
|
items.reference_number | string |
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. |
Retrieves all tags
Retrieves all the tags for this dashboard. Tags are unique between dashboards.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Number page to get
|
page | True | integer |
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. |
|
Amount of each entity to get per page
|
page_size | True | integer |
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. |
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
page
|
meta.page | integer |
The page of entities gotten. The amount of entities in this page is defined by page_size. |
|
page_size
|
meta.page_size | integer |
The number of entities gotten in this page. |
|
total_items
|
meta.total_items | integer |
The number of entities available in the database, regardless of the page size or number. To see the other pages, change the page number in the request. |
|
items
|
items | array of object |
List of tag entities gotten from Text Request. |
|
id
|
items.id | string |
The numerical id of the tag. |
|
tag_color
|
items.tag_color | string |
The color of the tag. This should be a valid hexadecimal color code. |
|
tag
|
items.tag | string |
The name of the tag. |
Retrieves the contact with the specified phone number
If a contact does not yet exist with this phone number in this dashboard, no content will be returned, and no error will be thrown. Only the dashboard specified will be searched; contacts are organized by dashboard, and there is no account level search for a number available.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of the contact
|
phone_number | True | string |
Phone number of the contact to get. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
phone_number
|
phone_number | string |
Phone number of this contact. |
|
first_name
|
first_name | string |
First name of this contact. |
|
last_name
|
last_name | string |
Last name of this contact. |
|
display_name
|
display_name | string |
Full name of this contact. This is the default name displayed in the web app when viewing contacts. |
|
is_suppressed
|
is_suppressed | boolean |
Whether the conversation with this contact are suppressed, and therefore not pushed to the top of the message queue when received. |
|
is_archived
|
is_archived | boolean |
Whether the conversation with this contact are archived, and therefore cannot be seen when querying conversations (by default). |
|
is_blocked
|
is_blocked | boolean |
Whether the conversation with this contact are blocked, and therefore not received or stored. |
|
suppressed_reason
|
suppressed_reason | string |
Phrase describing the reason for suppressing contact. If is_suppressed is false, this will be null. |
|
note
|
note | string |
Short phrase describing contact. Used for convenience. This is never shown to the contact. |
|
groups
|
groups | array of integer |
Array of integer ids referring to groups this contact belongs to. |
|
contact_tags
|
contact_tags | array of string |
Array of guids referring to tags attached to this contact. |
|
custom_fields
|
custom_fields | array of object |
Array of custom field ids and values defined for this contact. |
|
id
|
custom_fields.id | string |
Guid referring to a custom field. |
|
value
|
custom_fields.value | string |
This contact's value for this custom field. |
|
is_resolved
|
is_resolved | boolean |
Whether the conversation with this contact is resolved. Any new texts received by this contact will set this false. |
|
first_contact_utc
|
first_contact_utc | string |
Timestamp of when the first message was sent to this contact. |
|
opted_out_utc
|
opted_out_utc | string |
Timestamp of when this contact opted out to receiving messages. |
|
last_msg_sent_utc
|
last_msg_sent_utc | string |
Timestamp of when the last message was sent to this contact. |
|
last_msg_received_utc
|
last_msg_received_utc | string |
Timestamp of when the last message was received from this contact. |
|
total_msgs_sent
|
total_msgs_sent | integer |
The number of total messages sent to this contact. |
|
total_msgs_received
|
total_msgs_received | integer |
The number of total messages received from this contact. |
|
response_count
|
response_count | integer |
The total number of response messages from the contact. |
|
date_created_utc
|
date_created_utc | string |
The timestamp of when ths contact was created. |
|
last_contact_date_utc
|
last_contact_date_utc | string |
The timestamp of when the last message was sent or received from this contact. |
|
message_id
|
last_message.message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
last_message.body | string |
Content of this message. |
|
message_direction
|
last_message.message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
last_message.response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
last_message.message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
last_message.delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
last_message.delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
last_message.mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Retrieves the payment with the specified id
Retrieves the payment with the specified id.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the payment
|
payment_id | True | integer |
The numerical id of the payment to get. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
The numerical id of the payment. |
|
request_date
|
request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
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. |
|
reference_number
|
reference_number | string |
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. |
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
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the payment
|
payment_id | True | integer |
The numerical id of the payment to update. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
payment_id
|
payment_id | integer |
The numerical id of the payment. |
|
request_date
|
request_date | string |
The timestamp of when this payment's initial message was queued to be sent. |
|
recipient
|
recipient | string |
The name of the payment recipient. This may be null if the contact does not have a name associated with their phone number. |
|
description
|
description | string |
The description of the payment. This is not shown to the contact. It is only used by internal users for context about payments. |
|
customer_phone
|
customer_phone | string |
The phone number of the contact who is being sent this payment. |
|
amount_requested
|
amount_requested | float |
The amount in dollars requested by this payment. |
|
is_past_due
|
is_past_due | boolean |
Whether this payment is past the request date. |
|
reminder_was_sent
|
reminder_was_sent | boolean |
Whether a text reminder has already been sent for this payment. |
|
transaction_status
|
transaction_status | string |
The status of the transaction in authvia. This value starts as Unknown. |
|
textrequest_payment_status
|
textrequest_payment_status | string |
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. |
|
reference_number
|
reference_number | string |
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. |
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).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number to Message
|
phone_number | True | string |
Phone number of the contact to send a message to. |
|
Message body
|
body | string |
Content of the message to send. |
|
|
Name of the sender
|
sender_name | string |
The name of the message sender. This is shown in the TextRequest web app and api when retrieving this message. |
|
|
Callback url for when the message status updates
|
status_callback | string |
Url for the web app to hit with a POST command whenever this message's status goes from undelivered to sent (or error). |
|
|
Callback url for location requests if this message includes one
|
location_callback | string |
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. |
|
|
MMS Media attachments for this message
|
mms_media | array of string |
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. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
message_id
|
message_id | string |
Id of the message. This value is unique for each message. |
|
body
|
body | string |
Content of this message. |
|
message_direction
|
message_direction | string |
Singular character, either R or S, denoting whether this message was received from the contact or sent to them, respectively. |
|
response_by_username
|
response_by_username | string |
Username of the Text Request user that last sent a message to this user. |
|
message_timestamp_utc
|
message_timestamp_utc | string |
Timestamp of when the message was sent or received by Text Request. |
|
delivery_status
|
delivery_status | string |
Current status of this message. This can be 'sending', 'delivered', 'error', or 'send'. |
|
delivery_error
|
delivery_error | string |
Error that caused this message to not be delivered. If the delivery_status is not 'error', this value will be null. |
|
mms_media
|
mms_media | array of string |
List of urls pointing to this message's attachments. All urls will be text-request generated urls. |
Unarchive a Conversation
Unarchive 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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Phone Number of conversation
|
phone_number | True | string |
Phone number of the conversation to archive. |
Returns
- response
- string
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Dashboard name
|
name | string |
The new name of the dashboard. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the dashboard. |
|
name
|
name | string |
The name of the dashboard. |
|
phone
|
phone | string |
The texting number associated with this dashboard. |
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.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the dashboard to make this call on
|
dashboard_id | True | integer |
The phone number dashboard to work on. A single account can have several dashboards, representing different phone lines for customers. |
|
Id of the group
|
group_id | True | integer |
The numerical id of the group to update. |
|
Group name
|
name | string |
The new name of the group. |
|
|
Group note
|
notes | string |
Short phrase describing group. Used for convenience. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
The numerical id of the group. |
|
group_member_count
|
group_member_count | integer |
The number of members of the group. |
|
is_keyword
|
is_keyword | boolean |
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. |
|
name
|
name | string |
The name of this group. |
|
notes
|
notes | string |
Any notes on this group. |
|
last_message_sent_utc
|
last_message_sent_utc | string |
Timestamp of when the last group message was sent for this group. |
Definitions
string
This is the basic data type 'string'.