Get all immediate campaigns from the SimpleTexting system. Please note that none of your scheduled or recurring campaigns will be returned by this request.

Example: We request all SENT campaigns sent from the 8005551234 number to the list My First List:

https://api-app2.simpletexting.com/v2/api/campaigns?page=100&size=2&accountPhone=8005551234&state=SENT&listNameOrId=My First List&startDateFrom=2021-04-28T23:20:08.489Z&startDateTo=2021-05-28T23:20:08.489Z

Create and send a campaign.

Example: Here we created a campaign from our short code 8005551234 and sent it to a segment identified here by its ID, along with a list called My First List. We also specified that the First Name custom field will only take up 20 characters. Finally, we specified that 2 pieces of media will be attached. One is housed on SimpleTexting and identified by its ID, the other is getting pulled from an external link:

{ "title": "My first campaign", "listsOrSegments": [ "507f191e810c19729de860ea", "My First List" ], "accountPhone": "8005551234", "customFieldsMaxLength": { "firstName": 20 }, "messageTemplate": { "title": "My first campaign", "subject": "My first campaign", "text": "Hi %%firstname%%, welcome to our campaign!", "fallbackText": "My first campaign", "mediaItems": [ "https://txt.so/img.jpg", "507f1f77bcf86cd799439011" ] } }

Get a campaign via its unique ID.

Example: Below, we return the information associated with the campaign whose ID is 507f1f77bcf86cd799439011. You can use the Get all Campaigns endpoint to retrieve campaign IDs for all of your campaigns:

https://api-app2.simpletexting.com/v2/api/507f1f77bcf86cd799439011

Retrieves a list of all messages sent to a specific contact from a specific number on your account.

Example: Here we return all messages from an account:

https://api-app2.simpletexting.com/v2/api/messages?page=100&size=500

Send either an MMS or SMS message to a contact. Use this programmatically to send to multiple contacts.

If the message contains a link from a common third-party link shortener such as bit.ly, it will appear from our URL shortener instead and occupy 20 characters. Learn more.

There are limitations on Media Files with MMS messages. The size limitations of these items are discussed here.

Example: Below, we have an example of an MMS message being sent. We specified that we wanted to send an MMS message to 1234567 from one of the numbers on our account - 8005551234. We also provided some fallback text, should the receiving cell phone be unable to receive an MMS, and provided a link/ID to the media we wished to attach:

{ "contactPhone": "1234567890", "accountPhone": "8005551234", "mode": "MMS_PREFERRED", "text": "Hello! How are you?", "subject": "Some message from SimpleTexting", "fallbackText": "[url=%%fallback_link%%]", "mediaItems": [ "https://txt.so/img.jpg", "507f1f77bcf86cd799439011" ] }

Evaluate the body of your message before sending it to a contact or contacts.

Example: We evaluate a message to determine a number of properties. These include the number of credits it will use, whether it is an extended SMS or a regular SMS and any potential errors that may occur:

https://api-app2.simpletexting.com/v2/api/messages/evaluate

Retrieve a specific message from the system via its message ID.

Example: Below, we return the information associated with the message whose ID is 507f1f77bcf86cd799439011. You can use the Get all Messages endpoint to retrieve message IDs for all of your messages:

https://api-app2.simpletexting.com/v2/api/messages/507f1f77bcf86cd799439011

Upload a media file from a local directory to SimpleTexting.

Example: Here we upload an image from our local directory using an HTTP request. We state that the media should be shared with teammates:

POST /api/mediaitems/upload?shared=true HTTP/1.1 Host: https://api-app2.simpletexting.com/v2/ accept: */* Authorization: Bearer {{YOUR_TOKEN}} Content-Length: 176 Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW ----WebKitFormBound

This endpoint allows you to upload media via a URL so that you can send it in a message to a contact.

Example: Below we upload some media via a hosted URL to the SimpleTexting system:

{ "link": "https://dropbox.com/uploads/2019/08/7kAnVTq5Pb9TxEJbBNMDwh-768-80-1.jpg" }

This endpoint allows you to retrieve all Media Items.

Example: Here we return all Media Items from an account:

https://api-app2.simpletexting.com/v2/api/mediaitems?page=100&size=500

Remove media that you have previously uploaded to SimpleTexting.

Example: Here we delete a Media Item whose ID is507f1f77bcf86cd799439011. You can use the Get all Media Items endpoint to retrieve Media Items IDs for all of your Media Items:

https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011

Get a contact via their unique ID or phone number. Phone number is the preferred parameter for this call.

Example: Below, we return the information associated with the Contact whose ID is 507f1f77bcf86cd799439011. You can use the Get all Contacts endpoint to retrieve contact IDs for all of your contacts:

https://api-app2.simpletexting.com/v2/api/contacts/507f1f77bcf86cd799439011

Update a contact’s phone number or any other field.

Example: Below we update our contact, 3051234567. We declared their custom field value for zipcode is 12345 and that they get added to the list with an ID 507f191e810c19729de860ea and another list called My First List. In our URL, we requested that the contact gets added to a new list while remaining on the current one. We also requested not to update the contact's information if they already exist within the system:

URL:

https://api-app2.simpletexting.com/v2/api/contacts/3051234567?listsReplacement=false&false

Request Body:

{ "contactPhone": "1234567890", "firstName": "John", "lastName": "Doe", "email": "[email protected]", "birthday": "1985-05-15", "customFields": { "zipcode": "12345" }, "comment": "VIP client", "listIds": [ "507f191e810c19729de860ea", "My First List" ] }

Delete a contact via their unique ID or phone.

Example: Here we delete a Contact whose ID is507f1f77bcf86cd799439011. You can use the Get all Contacts endpoint to retrieve Contact IDs for all of your Contacts:

https://api-app2.simpletexting.com/v2/api/webhooks/507f1f77bcf86cd799439011

For a given account, return all contacts that have been created in the account. A paginated list of contacts will be returned to you:

Example: Here we return all Contacts from an account since April 28th 2021:

https://api-app2.simpletexting.com/v2/api/contacts?page=100&size=2&since=2021-04-28T23:20:08.489Z&direction=ASC

Create a new contact and add them to a specific list.

Example: Below we created our contact, John Doe. We declared his custom field value for zipcode is 12345 and that he gets added to the list with an ID 507f191e810c19729de860ea and another list called My First List:

{ "contactPhone": "1234567890", "firstName": "John", "lastName": "Doe", "email": "[email protected]", "birthday": "1985-05-15", "customFields": { "zipcode": "12345" }, "comment": "VIP client", "listIds": [ "507f191e810c19729de860ea", "My First List" ] }

Update multiple fields at once for a batch of contacts. You can update their first name, last name, emails, lists, and more.

Example: Here we are updating two contacts, seen in the array. The list replacement is set to true, so they will be removed from their existing list and added to a new one:

{ "updates": [ { "contactPhone": "1234567890", "firstName": "John", "lastName": "Doe", "email": "[email protected]", "birthday": "1985-05-15", "customFields": { "zipcode": "12345" }, "comment": "VIP client", "listIds": [ "507f191e810c19729de860ea", "My First List" ] },{ "contactPhone": "0987654321", "firstName": "Jane", "lastName": "Doe", "email": "[email protected]", "birthday": "1984-05-25", "customFields": { "zipcode": "54321" }, "comment": "VIP client", "listIds": [ "507f191e810c19729de860ea", "My First List" ] } ], "listsReplacement": true }

Step 1: Start the task for the batch update with the above parameters. As a result, you receive the task ID.

Example:

{ "id": "6176fb3e141c0060668b2c03" }

Step 2: Request the task result by adding task ID from Step 1 to the Get update result request.

Example:

{ "status": "DONE", "results": [{ "done": true, "contactPhone": "1234567890", "contactId": "6176f999141c0060668b258e" }, { "done": true, "contactPhone": "0987654321", "contactId": "1236f555141c0060668b123e"}], "requestedCount": 2, "processedCount": 2 }

Delete a group of contacts from SimpleTexting using their phone numbers.

Example: Below, we delete a batch of contacts identified here by their phone number in the array:

{ "contactPhones": [ "1234567890", "0987654321", "1122334455" ] }

Return the result of a batch update by the task id.

Update the name of an existing list.

Example: Here we updated a list name with a new name My Newer List:

{ "name": "My Newer List" }

Retrieves all lists from your SimpleTexting account.

Example: Here we return all lists from an account:

https://api-app2.simpletexting.com/v2/api/contact-lists?page=100&size=2

This endpoint is used to create a new contact list in a given SimpleTexting account.

Example: Here we create a list whose name is My New List:

{ "name": "My New List" }

Add contact to specified list.

Return a contact list by its unique list ID or name.

Example: Below, we return the information associated with the List whose ID is 507f1f77bcf86cd799439011. You can use the Get all Lists endpoint to retrieve List IDs for all of your Lists:

https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011

Delete an existing list using the list ID or name.

Example: Here we delete a List whose ID is507f1f77bcf86cd799439011. You can use the [Get all Lists] (#operation/getLists) endpoint to retrieve List IDs for all of your Lists:

https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011

Remove contact from specified list.

Retrieves all segments from your SimpleTexting account.

Example: Here we return all segments from an account:

https://api-app2.simpletexting.com/v2/api/contact-segments?page=100&size=2

This endpoint allows you to retrieve all custom fields.

Example: Here we return all Custom Fields from an account:

https://api-app2.simpletexting.com/v2/api/custom-fields?page=100&size=500

Update an existing webhook using its unique ID.

Delete an existing Webhook by its unique ID.

Example: Here we delete a Webhook whose ID is507f1f77bcf86cd799439011. You can use the Get all Webhooks endpoint to retrieve message IDs for all of your Webhooks:

https://api-app2.simpletexting.com/v2/api/webhooks/507f1f77bcf86cd799439011

Retrieve all the webhooks that you've created.

Example: Here we return all Webhooks from an account:

https://api-app2.simpletexting.com/v2/api/webhooks

Create a new webhook from scratch.

Triggers when a client sends STOP to your number.

Example: We create the Unsubscribe report for 8005551234 for the status of the outgoing messages to 8001234567:

{"url": "http://www.yourdomain.com/unsubscribe.php","triggers": ["UNSUBSCRIBE_REPORT"],"requestPerSecLimit": 25,"accountPhone": "8005551234","contactPhone": "8001234567"}

Your custom domain http://www.yourdomain.com/unsubscribe.php has been set as an unsubscribe report URL for this example. The SimpleTexting server will invoke the given call when the subscriber with the number 8001234567 unsubscribes.

Triggers when an outgoing message or incoming message is handled.

Example: We create the incoming webhook for 8005551234 from contact phone 8001234567:

{"url": "http://www.yourdomain.com/receivesms.php","triggers": ["INCOMING_MESSAGE"],"requestPerSecLimit": 25,"accountPhone": "8005551234","contactPhone": "8001234567"}

Triggers when an outgoing message is reported as delivered or undelivered by the carrier.

Example: We create the Delivery report for 8005551234 for the status of the outgoing messages to 8001234567:

{"url": "http://www.yourdomain.com/delivery.php","triggers": ["DELIVERY_REPORT"],"requestPerSecLimit": 25,"accountPhone": "8005551234","contactPhone": "8001234567"}

Your custom domain http://www.yourdomain.com/delivery.php has been set as a delivery report webhook for this example. The SimpleTexting server will invoke the given call when a message with the messageId 507f191e810c19729de860ea is delivered.