EZ Texting
App · 18 actions
Manage EZ Texting contacts, groups and templates and send or read text messages.
Actions
| Action | What it does |
|---|---|
| Create a contact group | Create a contact group. |
| Create a message template | Create a message template. |
| Create or update a contact | Create or update a contact. |
| Delete a contact group | Delete a contact group. |
| Delete a message template | Delete a message template. |
| Get a contact | Get a contact. |
| Get a contact group | Get a contact group. |
| Get a message template | Get a message template. |
| Get credit balance | Get credit balance. |
| Get message details | Get message details. |
| List contact groups | List contact groups. |
| List contacts | List contacts. |
| List message templates | List message templates. |
| List messages | List messages. |
| List webhooks | List webhook subscriptions and their callback URLs. |
| Send or schedule a message | Send or schedule a message. |
| Update a contact group | Update a contact group. |
| Update a message template | Update a message template. |
Create a contact group
Create a contact group.
Inputs
- Name
nametextRequired - The group name, max length 25 chars
- Note
notetext - Notes related to contact group
- Phone numbers
phone_numberslist - Phone numbers of contacts to add to this group
- Group IDS
group_idslist - Groups of contacts to merge into this group
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"id": "example"
}
}Create a message template
Create a message template.
Inputs
- Name
nametextRequired - Message template name
- Company name
company_nametext - Company name
- Message
messagetextRequired - Message text
- Media file ID
media_file_idtext - Media file id
- Media file URL
media_file_urltext - Medial file url
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"id": "example"
}
}Create or update a contact
Create or update a contact.
Inputs
- Phone number
phone_numbertextRequired - Phone number
- First name
first_nametext - First name
- Last name
last_nametext - Last name
- Email
emailtext - Email address
- Note
notetext - Notes
- Group IDS add
group_ids_addlist - Groups to add contact to
- Group IDS remove
group_ids_removelist - Groups to remove contact from
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"id": "example"
}
}Delete a contact group
Delete a contact group.
Inputs
- Contact group
contact_group_idtextRequired - Contact group id
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {}
}Delete a message template
Delete a message template.
Inputs
- Message template
message_template_idtextRequired - Message template id
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {}
}Get a contact
Get a contact.
Inputs
- Phone number
phone_numbertextRequired - Phone number
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"createdAt": "example",
"custom1": "example",
"custom2": "example",
"custom3": "example",
"custom4": "example",
"custom5": "example",
"email": "example",
"firstName": "example",
"groups": [
{
"contactsCount": 1,
"id": "example",
"name": "example",
"note": "example"
}
],
"lastName": "example",
"note": "example",
"optOut": true,
"phoneNumber": "example",
"source": 1,
"updatedAt": "example",
"values": {}
}
}Get a contact group
Get a contact group.
Inputs
- Contact group
contact_group_idtextRequired - Contact group id
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"contactsCount": 1,
"id": "example",
"name": "example",
"note": "example"
}
}Get a message template
Get a message template.
Inputs
- Message template
message_template_idtextRequired - Message template id
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"companyName": "example",
"id": "example",
"mediaFile": {
"id": "example",
"name": "example",
"type": "example",
"uploadAt": "example",
"url": "example"
},
"message": "example",
"name": "example"
}
}Get credit balance
Get credit balance.
Inputs
None.
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"anytimeCredits": 1,
"planCredits": 1,
"totalCredits": 1
}
}Get message details
Get message details.
Inputs
- Message ID
message_idtextRequired - Message ID.
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"contacts": [
{
"createdAt": "example",
"custom1": "example",
"custom2": "example",
"custom3": "example",
"custom4": "example",
"custom5": "example",
"email": "example",
"firstName": "example",
"groups": [
{}
],
"lastName": "example",
"note": "example",
"optOut": true,
"phoneNumber": "example",
"source": 1,
"updatedAt": "example",
"values": {}
}
],
"credits": 1,
"fromNumber": "example",
"groups": [
{
"contactsCount": 1,
"id": "example",
"name": "example",
"note": "example"
}
],
"recipientsCount": 1,
"sentOn": "example",
"type": "example"
}
}List contact groups
List contact groups.
Inputs
- Page
pagenumber - Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
- Size
sizetext - The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200One of:
10,20,50,100,200. - Sort
sorttext - Sort field name and direction (asc or desc). Example: sort=created,desc
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"content": [
{
"contactsCount": 1,
"id": "example",
"name": "example",
"note": "example"
}
],
"number": 1,
"numberOfElements": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}List contacts
List contacts.
Inputs
- Page
pagenumber - Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
- Size
sizetext - The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200One of:
10,20,50,100,200. - Sort
sorttext - Sort field name and direction (asc or desc). Example: sort=created,desc
- Filters phone number like
filters_phone_number_liketext - Filter by phone number
- Filters first name like
filters_first_name_liketext - Filter by first name
- Filters last name like
filters_last_name_liketext - Filter by last name
- Filters email like
filters_email_liketext - Filter by email
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"content": [
{
"createdAt": "example",
"custom1": "example",
"custom2": "example",
"custom3": "example",
"custom4": "example",
"custom5": "example",
"email": "example",
"firstName": "example",
"groups": [
{}
],
"lastName": "example",
"note": "example",
"optOut": true,
"phoneNumber": "example",
"source": 1,
"updatedAt": "example",
"values": {}
}
],
"number": 1,
"numberOfElements": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}List message templates
List message templates.
Inputs
- Page
pagenumber - Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
- Size
sizetext - The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200One of:
10,20,50,100,200. - Sort
sorttext - Sort field name and direction (asc or desc). Example: sort=created,desc
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"content": [
{
"companyName": "example",
"id": "example",
"mediaFile": {
"id": {},
"name": {},
"type": {},
"uploadAt": {},
"url": {}
},
"message": "example",
"name": "example"
}
],
"number": 1,
"numberOfElements": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}List messages
List messages.
Inputs
- Page
pagenumber - Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
- Size
sizetext - The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200One of:
10,20,50,100,200. - Sort
sorttext - Sort field name and direction (asc or desc). Example: sort=created,desc
- Filters contact number eq
filters_contact_number_eqtext - Filter by contact phone number
- Unread
unreadtrue/false - Filter by unread flag: true for unread, false for read
- Incoming
incomingtrue/false - Filter by incoming flag: true for incoming, false for outgoing
- Start time
start_timedate and time - Filter by sentAt after - example: 2020-01-03T10:15:30+00:00
- End time
end_timedate and time - Filter by sentAt before - example: 2020-01-04T10:15:30+00:00
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"content": [
{
"contactNumber": "example",
"group": true,
"id": "example",
"inbound": true,
"mediaUrl": "example",
"message": "example",
"messageGroupId": "example",
"optIn": true,
"optOut": true,
"sentAt": "example",
"status": "example",
"type": "example",
"userNumber": "example"
}
],
"number": 1,
"numberOfElements": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}List webhooks
List webhook subscriptions and their callback URLs.
Inputs
- Page
pagenumber - Offset of a given page. The default is 0. See [pagination](https://eztexting.readme.io/docs/pagination) docs for more information.
- Size
sizetext - The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200One of:
10,20,50,100,200. - Sort
sorttext - Sort field name and direction (asc or desc). Example: sort=created,desc
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"content": [
{
"callbackUrl": "example",
"id": "example",
"insecureSsl": true,
"type": "example"
}
],
"number": 1,
"numberOfElements": 1,
"size": 1,
"totalElements": 1,
"totalPages": 1
}
}Send or schedule a message
Send or schedule a message.
Inputs
- Message
messagetext - The text message to send
- Send at
send_atdate and time - When to send the message (omit to send immediately) example: 2020-12-03T10:15:30+00:00
- Media URL
media_urltext - Media url - most standard format image, video and audio files supported up to 5MB
- Message template
message_template_idtext - Message template id to build message from
- From number
from_numbertext - Number to send from - only required if you have more than one number available to send from
- To numbers
to_numberslist - Collection of contact numbers to send to
- Group IDS
group_idslist - Collection of contact group ids to send to
- Message type
message_typetext - Requested message type to sendOne of:
SMS,MMS.
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {
"id": "example"
}
}Update a contact group
Update a contact group.
Inputs
- Contact group
contact_group_idtextRequired - Contact group id
- Name
nametext - The group name, max length 25 chars
- Note
notetext - Notes related to contact group
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {}
}Update a message template
Update a message template.
Inputs
- Message template
message_template_idtextRequired - Message template id
- Name
nametext - Message template name
- Company name
company_nametext - Company name
- Message
messagetext - Message text
Outputs
dataobject- The response from EZ Texting.
Example output
{
"data": {}
}