{ "item": [ { "id": "f0fead18-56f7-4e3b-ac70-c93eaf1d1f3b", "name": "Webhooks", "description": { "content": "Use webhooks to communicate between the SimpleTexting platform and your server. Webhooks can be used to forward messages as well as provide info about unsubscribes and message delivery.\n\nSimpleTexting can trigger webhooks for new incoming messages, delivery reports, unsubscribes, and more. Now you can build scripts that interpret and respond to events that occur in your SimpleTexting account! To set the URLs for your webhooks, visit the Webhooks tab on the API section of [settings](https://app2.simpletexting.com/integrations/webhooks).", "type": "text/plain" }, "item": [ { "id": "e395dc38-bb30-4221-8c07-fcba814a3c2b", "name": "Update a Webhook", "request": { "name": "Update a Webhook", "description": { "content": "Update an existing webhook using its unique ID.", "type": "text/plain" }, "url": { "path": [ "api", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhookId", "description": "(Required) Webhook ID in hexadecimal format" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"requestPerSecLimit\": \"\",\n \"accountPhone\": \"\",\n \"contactPhone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0cc9646e-985e-4ec5-bd32-430fa2c0f0ba", "name": "Success. Webhook was updated", "originalRequest": { "url": { "path": [ "api", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhookId", "description": "(Required) Webhook ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"requestPerSecLimit\": 15,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0418d4df-56fc-486a-b19a-8058e7c5a719", "name": "Error. Webhook not found.", "originalRequest": { "url": { "path": [ "api", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhookId", "description": "(Required) Webhook ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"requestPerSecLimit\": 15,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "eda004b6-2fca-422f-b9ab-94b9df4e4262", "name": "Delete a Webhook", "request": { "name": "Delete a Webhook", "description": { "content": "Delete an existing Webhook by its unique ID.\n\n**Example:** Here we delete a Webhook whose ID is`507f1f77bcf86cd799439011`. You can use the [Get all Webhooks](#operation/getWebhooks) endpoint to retrieve message IDs for all of your Webhooks:\n\n`https://api-app2.simpletexting.com/v2/api/webhooks/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhookId", "description": "(Required) Webhook ID in hexadecimal format" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "dc043cab-9ae2-4ee9-a6c7-0f2c8078ee4c", "name": "Success. Webhook was deleted.", "originalRequest": { "url": { "path": [ "api", "webhooks", ":webhookId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "webhookId", "description": "(Required) Webhook ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3f0f6ba0-3027-457a-ba78-ddfd2dbdd82a", "name": "Get all Webhooks", "request": { "name": "Get all Webhooks", "description": { "content": "Retrieve all the webhooks that you've created.\n\n**Example:** Here we return all Webhooks from an account:\n\n`https://api-app2.simpletexting.com/v2/api/webhooks`", "type": "text/plain" }, "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the webhooks of the given account). Please note that page numbering starts at zero (`0`)" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned webhooks to show per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c889c36f-6c73-4c0b-94cd-4dab4fd03a8b", "name": "Success. Returns page of webhooks.", "originalRequest": { "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "5" }, { "key": "size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"triggers\": [\n \"INCOMING_MESSAGE\",\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"webhookId\": \"507f191e810c19729de860ea\",\n \"requestPerSecLimit\": 20,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n },\n {\n \"triggers\": [\n \"INCOMING_MESSAGE\",\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"webhookId\": \"507f191e810c19729de860ea\",\n \"requestPerSecLimit\": 20,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n }\n ],\n \"totalPages\": 1469,\n \"totalElements\": 4400\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6eba6c5e-a131-4158-beac-8c04097c38a6", "name": "Create a Webhook", "request": { "name": "Create a Webhook", "description": { "content": "Create a new webhook from scratch.", "type": "text/plain" }, "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"requestPerSecLimit\": \"\",\n \"accountPhone\": \"\",\n \"contactPhone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "e300a96c-7474-4a20-9dae-28950df9a324", "name": "Success. Webhook was created.", "originalRequest": { "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"requestPerSecLimit\": 15,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce7954d6-5f27-4d3b-82e7-5cdbc4cbe537", "name": "Error. Invalid phone format.", "originalRequest": { "url": { "path": [ "api", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"triggers\": [\n \"INCOMING_MESSAGE\"\n ],\n \"url\": \"https://example.com\",\n \"requestPerSecLimit\": 15,\n \"accountPhone\": \"8881234567\",\n \"contactPhone\": \"3051234567\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f058ae76-cfac-46b6-bbc5-f95307030e79", "name": "Contact Lists", "description": { "content": "Create, update, and delete contact lists.", "type": "text/plain" }, "item": [ { "id": "f10438ae-9e8e-4e18-bd8f-f0606d987fd3", "name": "Update a List Name", "request": { "name": "Update a List Name", "description": { "content": "Update the name of an existing list.\n\n**Example:** Here we updated a list name with a new name `My Newer List`:\n\n`{ \"name\": \"My Newer List\" }`", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists", ":listId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listId", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My Newer list" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "dbc5ee81-4107-463d-aef2-b52074c69c0e", "name": "Success. List name updated", "originalRequest": { "url": { "path": [ "api", "contact-lists", ":listId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listId", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My Newer list" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"name\": \"My new list\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6fab46d5-af41-4061-8f93-900dfc336aef", "name": "Get all Lists", "request": { "name": "Get all Lists", "description": { "content": "Retrieves all lists from your SimpleTexting account.\n\n**Example:** Here we return all lists from an account:\n\n`https://api-app2.simpletexting.com/v2/api/contact-lists?page=100&size=2`", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the lists of the given account). Please note that page numbering starts at zero (`0`)\n\n**Example:** `15`" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned lists to show per page\n\n**Example:** `50`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "4bdfacff-030a-402b-bf57-3c6457137ecf", "name": "Success. Returns all lists in a given SimpleTexting account.", "originalRequest": { "url": { "path": [ "api", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "15" }, { "key": "size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"listId\": \"507f191e810c19729de860ea\",\n \"name\": \"My First List\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-04-28T23:20:08.489Z\",\n \"description\": \"List for 'SALE' keyword\",\n \"totalContactsCount\": 25,\n \"activeContactsCount\": 40,\n \"invalidContactsCount\": 1,\n \"unsubscribedContactsCount\": 2,\n \"keywords\": [\n \"MYFIRSTKEYWORD\",\n \"MYFIRSTKEYWORD\"\n ]\n },\n {\n \"listId\": \"507f191e810c19729de860ea\",\n \"name\": \"My First List\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-04-28T23:20:08.489Z\",\n \"description\": \"List for 'SALE' keyword\",\n \"totalContactsCount\": 25,\n \"activeContactsCount\": 40,\n \"invalidContactsCount\": 1,\n \"unsubscribedContactsCount\": 2,\n \"keywords\": [\n \"MYFIRSTKEYWORD\",\n \"MYFIRSTKEYWORD\"\n ]\n }\n ],\n \"totalPages\": 287,\n \"totalElements\": 2636\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26b2c340-e7c1-49e5-a7d0-de435f1ce775", "name": "Create a List", "request": { "name": "Create a List", "description": { "content": "This endpoint is used to create a new contact list in a given SimpleTexting account.\n\n**Example:** Here we create a list whose name is `My New List`:\n\n`{ \"name\": \"My New List\" }`", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "cba3bc4b-6d4a-46b9-bdb8-eefa0dfbd30b", "name": "Success. List created", "originalRequest": { "url": { "path": [ "api", "contact-lists" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"My new list\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "be0d9ad3-8ffe-4782-ad00-8a432d40bf05", "name": "Add Contact To List", "request": { "name": "Add Contact To List", "description": { "content": "Add contact to specified list.", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists", ":listIdOrName", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID or name to add the contact.\n\n**Example:** 507f191e810c19729de860ea / My First List" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contactPhoneOrId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "90f38291-c314-47ad-a109-fa2c1ce6d82b", "name": "Success. Fetched list.", "originalRequest": { "url": { "path": [ "api", "contact-lists", ":listIdOrName", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID or name to add the contact.\n\n**Example:** 507f191e810c19729de860ea / My First List" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactPhoneOrId\": \"3051234567 / 507f1f77bcf86cd799439011\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5834b582-3e3c-4b96-90a0-f576796982c2", "name": "Get a List", "request": { "name": "Get a List", "description": { "content": "Return a contact list by its unique list ID or name.\n\n**Example:** Below, we return the information associated with the List whose ID is `507f1f77bcf86cd799439011`. You can use the [Get all Lists](#operation/getLists) endpoint to retrieve List IDs for all of your Lists:\n\n`https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists", ":listIdOrName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My new list" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ebbb9189-626b-44ea-8c9b-4b8fe67b9737", "name": "Success. Fetched list.", "originalRequest": { "url": { "path": [ "api", "contact-lists", ":listIdOrName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My new list" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"listId\": \"507f191e810c19729de860ea\",\n \"name\": \"My First List\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-04-28T23:20:08.489Z\",\n \"description\": \"List for 'SALE' keyword\",\n \"totalContactsCount\": 25,\n \"activeContactsCount\": 40,\n \"invalidContactsCount\": 1,\n \"unsubscribedContactsCount\": 2,\n \"keywords\": [\n \"MYFIRSTKEYWORD\",\n \"MYFIRSTKEYWORD\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "87fe38aa-73f2-4716-883b-53d022b97757", "name": "Delete a List", "request": { "name": "Delete a List", "description": { "content": "Delete an existing list using the list ID or name.\n\n**Example:** Here we delete a List whose ID is`507f1f77bcf86cd799439011`. You can use the [Get all Lists] (#operation/getLists) endpoint to retrieve List IDs for all of your Lists:\n\n`https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists", ":listIdOrName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My new list" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "6f81b1e1-4b39-47c0-b179-e4ea4891c100", "name": "Success. List was deleted", "originalRequest": { "url": { "path": [ "api", "contact-lists", ":listIdOrName" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID in hexadecimal format or name.\n\n**Example:** 507f1f77bcf86cd799439011 / My new list" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "93eb6f6c-3a5e-46d0-a1ee-256d05235439", "name": "Remove Contact From List", "request": { "name": "Remove Contact From List", "description": { "content": "Remove contact from specified list.", "type": "text/plain" }, "url": { "path": [ "api", "contact-lists", ":listIdOrName", "contacts", ":contactPhoneOrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID or name to remove the contact from.\n\n**Example:** 507f191e810c19729de860ea / My First List" }, { "disabled": false, "type": "any", "value": "", "key": "contactPhoneOrId", "description": "(Required) Contact ID in hexadecimal format or the contact's phone number.\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "58b462de-dfb5-4a9c-81a6-040e8ab8d623", "name": "Success. Contact was removed from list.", "originalRequest": { "url": { "path": [ "api", "contact-lists", ":listIdOrName", "contacts", ":contactPhoneOrId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "listIdOrName", "description": "(Required) List ID or name to remove the contact from.\n\n**Example:** 507f191e810c19729de860ea / My First List" }, { "disabled": false, "type": "any", "value": "", "key": "contactPhoneOrId", "description": "(Required) Contact ID in hexadecimal format or the contact's phone number.\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "40383e27-69b3-4d41-85a6-8f1e991825ea", "name": "Contacts", "description": { "content": "At a minimum, each contact in SimpleTexting must have a phone number. Contacts can also hold additional information including first name, last name, and email address. You can also create custom fields to store data specific to your website or app’s needs.", "type": "text/plain" }, "item": [ { "id": "fbc9ea2b-cae2-4524-8b73-b3a4d007e789", "name": "Get a Contact", "request": { "name": "Get a Contact", "description": { "content": "Get a contact via their unique ID or phone number. Phone number is the preferred parameter for this call.\n\n**Example:** Below, we return the information associated with the Contact whose ID is `507f1f77bcf86cd799439011`. You can use the [Get all Contacts](#operation/getContacts) endpoint to retrieve contact IDs for all of your contacts:\n\n`https://api-app2.simpletexting.com/v2/api/contacts/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Phone number (preferred) or Contact ID in hexadecimal format\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "b1ca70dc-6fa3-4b72-a7a3-67731abd99ab", "name": "Success. Fetched contact.", "originalRequest": { "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Phone number (preferred) or Contact ID in hexadecimal format\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"contactId\": \"607f0558a7c898629dd47d7a\",\n \"contactPhone\": \"1234567890\",\n \"email\": \"john.doe@simpletext.org\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"birthday\": \"1985-05-15\",\n \"lists\": [\n {\n \"name\": \"list name\"\n }\n ],\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"subscriptionStatus\": \"OPT_IN\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-05-28T20:20:08.489Z\",\n \"updateSource\": \"IMPORTED_FROM_FILE\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "30c1eb96-47e2-4b02-a4a9-f71ad7cecac0", "name": "Update a Contact", "request": { "name": "Update a Contact", "description": { "content": "Update a contact’s phone number or any other field.\n\n**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:\n\nURL:\n\n`https://api-app2.simpletexting.com/v2/api/contacts/3051234567?listsReplacement=false&false`\n\nRequest Body:\n\n`{ \"contactPhone\": \"1234567890\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@simpletexting.net\", \"birthday\": \"1985-05-15\", \"customFields\": { \"zipcode\": \"12345\" }, \"comment\": \"VIP client\", \"listIds\": [ \"507f191e810c19729de860ea\", \"My First List\" ] }`", "type": "text/plain" }, "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "upsert", "value": "true", "description": "If a contact already exists with the phone number in your request body, the contact will be updated with the information in the request when upsert is set to true.\n\n**Example:** `false`" }, { "disabled": false, "key": "listsReplacement", "value": "true", "description": "If listsReplacement is set to true, a contact will be removed from their existing list. If set to false, a contact will be added to a new list and stay in their original list.\n\n**Example:** `false`" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Contact ID in hexadecimal format or the contact's phone number.\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "48a1ea28-e341-45ab-b2a1-5b1c8b5fff1f", "name": "Contact is updated.", "originalRequest": { "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "upsert", "value": "false" }, { "key": "listsReplacement", "value": "false" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Contact ID in hexadecimal format or the contact's phone number.\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletexting.net\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb696c00-b866-4f54-80a0-8c6d496deec0", "name": "Delete a Contact", "request": { "name": "Delete a Contact", "description": { "content": "Delete a contact via their unique ID or phone.\n\n**Example:** Here we delete a Contact whose ID is`507f1f77bcf86cd799439011`. You can use the [Get all Contacts](#operation/getContacts) endpoint to retrieve Contact IDs for all of your Contacts:\n\n`https://api-app2.simpletexting.com/v2/api/webhooks/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Contact ID in hexadecimal format or phone number\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "da8b3c64-ae23-4deb-a923-571ae8da9f22", "name": "Success. Contact is deleted.", "originalRequest": { "url": { "path": [ "api", "contacts", ":contactIdOrNumber" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "contactIdOrNumber", "description": "(Required) Contact ID in hexadecimal format or phone number\n\n**Example:** `3051234567 / 507f1f77bcf86cd799439011`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e88005d7-5928-4048-9983-ea65b989985b", "name": "Get all Contacts", "request": { "name": "Get all Contacts", "description": { "content": "For a given account, return all contacts that have been created in the account. A paginated list of contacts will be returned to you:\n\n**Example:** Here we return all Contacts from an account since April 28th 2021:\n\n`https://api-app2.simpletexting.com/v2/api/contacts?page=100&size=2&since=2021-04-28T23:20:08.489Z&direction=ASC`", "type": "text/plain" }, "url": { "path": [ "api", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the contacts of the given account). Please note that page numbering starts at zero (`0`)\n\n**Example:** `250`" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned contacts to show per page\n\n**Example:** `150`" }, { "disabled": false, "key": "since", "value": "", "description": "List contacts updated since a specified date. The time is in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.\n\n**Example:** `2021-04-28T23:20:08.489Z`" }, { "disabled": false, "key": "direction", "value": "desc", "description": "Specify the sort order of your results. By default, results are sorted by the 'updated' field:\n\n- **ASC:** Sort values in *ascending* order\n\n- **DESC:** Sort values in *descending* order\n\n**Example:** `desc`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "0da7d04a-0c58-4032-86b9-975065725165", "name": "Success. Returns a paginated list of contacts.", "originalRequest": { "url": { "path": [ "api", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "250" }, { "key": "size", "value": "150" }, { "key": "since", "value": "2021-04-28T23:20:08.489Z" }, { "key": "direction", "value": "desc" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"contactId\": \"607f0558a7c898629dd47d7a\",\n \"contactPhone\": \"1234567890\",\n \"email\": \"john.doe@simpletext.org\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"birthday\": \"1985-05-15\",\n \"lists\": [\n {\n \"name\": \"list name\"\n }\n ],\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"subscriptionStatus\": \"OPT_IN\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-05-28T20:20:08.489Z\",\n \"updateSource\": \"IMPORTED_FROM_FILE\"\n },\n {\n \"contactId\": \"607f0558a7c898629dd47d7a\",\n \"contactPhone\": \"1234567890\",\n \"email\": \"john.doe@simpletext.org\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"birthday\": \"1985-05-15\",\n \"lists\": [\n {\n \"name\": \"list name\"\n }\n ],\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"subscriptionStatus\": \"OPT_IN\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"updated\": \"2021-05-28T20:20:08.489Z\",\n \"updateSource\": \"IMPORTED_FROM_FILE\"\n }\n ],\n \"totalPages\": 9674,\n \"totalElements\": 2462\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8621ae6d-9a67-4202-b7e4-859397e98e92", "name": "Create a Contact", "request": { "name": "Create a Contact", "description": { "content": "Create a new contact and add them to a specific list.\n\n**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`:\n\n`{ \"contactPhone\": \"1234567890\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@simpletexting.net\", \"birthday\": \"1985-05-15\", \"customFields\": { \"zipcode\": \"12345\" }, \"comment\": \"VIP client\", \"listIds\": [ \"507f191e810c19729de860ea\", \"My First List\" ] }`", "type": "text/plain" }, "url": { "path": [ "api", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "upsert", "value": "true", "description": "If a contact already exists with the phone number in your request body, the contact will be updated with the information in the request when upsert is set to true." }, { "disabled": false, "key": "listsReplacement", "value": "true", "description": "If listsReplacement is set to true, a contact will be removed from their existing list. If set to false, a contact will be added to a new list and stay in their original list." } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "425a52dd-26bc-475f-bb68-5d40a0b5715c", "name": "Success. Contact created.", "originalRequest": { "url": { "path": [ "api", "contacts" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "upsert", "value": "false" }, { "key": "listsReplacement", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletexting.net\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "c397f66c-1eb3-42ec-9980-d82485edc349", "name": "Campaigns", "description": { "content": "Send and manage campaigns directly from the SimpleTexting API. The endpoint allows you to Create and Send a campaign, get a specific campaign by its name or ID, or list all of your SimpleTexting campaigns. \n\n**Note:** 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](https://help.simpletexting.com/en/articles/3362741-why-carriers-don-t-allow-bit-ly-and-other-third-party-link-shorteners).", "type": "text/plain" }, "item": [ { "id": "f1b0f869-8401-407e-af33-75461656e664", "name": "Get all Campaigns", "request": { "name": "Get all Campaigns", "description": { "content": "Get all campaigns from the SimpleTexting system. You can filter campaigns by type using the `type` query parameter. By default, if `type` is not specified, only immediate campaigns are returned (scheduled and recurring campaigns will not be included).\n\n**Example:** We request all `SENT` campaigns sent from the `8005551234` number to the list `My First List`:\n\n`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`", "type": "text/plain" }, "url": { "path": [ "api", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the campaigns sent from the given number). Please note that page numbering starts at zero (`0`)" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned campaigns to show per page" }, { "disabled": false, "key": "accountPhone", "value": "", "description": "The phone number the campaign was sent from" }, { "disabled": false, "key": "type", "value": "", "description": "The type of the campaigns you wish to retrieve:\n\n - **ALL:** Returns all campaign types\n\n - **IMMEDIATELY:** Returns immediate campaigns\n\n - **SCHEDULED:** Returns scheduled campaigns\n\n - **RECURRING:** Returns recurring campaigns\n\n - **RECURRING_SCHEDULED:** Returns recurring scheduled campaigns" }, { "disabled": false, "key": "state", "value": "", "description": "The current state of the campaigns you wish to retrieve:\n\n - **ERROR:** Returns campaigns that were not sent because of errors\n\n - **PAUSED:** Returns Paused campaigns on your account\n\n - **SENDING:** Returns sending campaigns\n\n - **COMPLETED:** Returns all successfully sent campaigns on your account\n\n - **MONITORING:** Returns all campaigns that includes \"stop\" words or malicious links" }, { "disabled": false, "key": "listNameOrId", "value": "", "description": "The list name or list ID" }, { "disabled": false, "key": "startDateFrom", "value": "", "description": "List campaigns starting from a certain date. The time is in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, { "disabled": false, "key": "startDateTo", "value": "", "description": "List campaigns up to a certain date. The time is in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a29f35a5-3639-4663-9aa5-87256277a166", "name": "Success. Fetched list of campaigns", "originalRequest": { "url": { "path": [ "api", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "100" }, { "key": "size", "value": "2" }, { "key": "accountPhone", "value": "" }, { "key": "type", "value": "IMMEDIATELY" }, { "key": "state", "value": "SENDING" }, { "key": "listNameOrId", "value": "My First List" }, { "key": "startDateFrom", "value": "2021-04-28T23:20:08.489Z" }, { "key": "startDateTo", "value": "2021-05-28T23:20:08.489Z" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"accountPhone\": \"8005551234\",\n \"campaignId\": \"607f0558a7c898629dd47d7a\",\n \"lists\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"messageTemplate\": {\n \"text\": \"Hello! How are you?\",\n \"category\": \"MMS\",\n \"subject\": \"Some message from SimpleTexting\",\n \"fallbackText\": \"We sent you a message!\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439333\"\n ]\n },\n \"segments\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"state\": \"COMPLETED\",\n \"title\": \"My first campaign\",\n \"customFieldsMaxLength\": {\n \"key_0\": 1112,\n \"key_1\": 7687\n },\n \"type\": \"IMMEDIATELY\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"modified\": \"2021-04-28T23:20:08.489Z\",\n \"started\": \"2021-04-28T23:20:08.489Z\",\n \"finished\": \"2021-04-28T23:20:08.489Z\",\n \"origin\": \"API_V2\",\n \"outcome\": {\n \"successRate\": 100,\n \"optOutRate\": 0,\n \"totalSent\": 1000,\n \"creditsTotal\": 1000\n },\n \"trackingLinks\": [\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n },\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n }\n ]\n },\n {\n \"accountPhone\": \"8005551234\",\n \"campaignId\": \"607f0558a7c898629dd47d7a\",\n \"lists\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"messageTemplate\": {\n \"text\": \"Hello! How are you?\",\n \"category\": \"MMS\",\n \"subject\": \"Some message from SimpleTexting\",\n \"fallbackText\": \"We sent you a message!\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439333\"\n ]\n },\n \"segments\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"state\": \"COMPLETED\",\n \"title\": \"My first campaign\",\n \"customFieldsMaxLength\": {\n \"key_0\": 8224,\n \"key_1\": 5527,\n \"key_2\": 8668\n },\n \"type\": \"IMMEDIATELY\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"modified\": \"2021-04-28T23:20:08.489Z\",\n \"started\": \"2021-04-28T23:20:08.489Z\",\n \"finished\": \"2021-04-28T23:20:08.489Z\",\n \"origin\": \"API_V2\",\n \"outcome\": {\n \"successRate\": 100,\n \"optOutRate\": 0,\n \"totalSent\": 1000,\n \"creditsTotal\": 1000\n },\n \"trackingLinks\": [\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n },\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n }\n ]\n }\n ],\n \"totalPages\": 4889,\n \"totalElements\": 7739\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5ce3183d-0e63-4fa9-ac89-8bdfcfdea692", "name": "Send a Campaign", "request": { "name": "Send a Campaign", "description": { "content": "Create and send a campaign.\n\n**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:\n\n`{ \"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\" ] } }`", "type": "text/plain" }, "url": { "path": [ "api", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"messageTemplate\": {\n \"mode\": \"\",\n \"text\": \"\",\n \"subject\": \"\",\n \"unsubscribeText\": \"\",\n \"fallbackText\": \"\",\n \"fallbackUnsubscribeText\": \"\",\n \"mediaItems\": [\n \"\",\n \"\"\n ]\n },\n \"title\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ],\n \"segmentIds\": [\n \"\",\n \"\"\n ],\n \"accountPhone\": \"\",\n \"customFieldsMaxLength\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "4690e339-2de5-46f6-a526-fe81bf8dc8c6", "name": "Success. Campaign was created", "originalRequest": { "url": { "path": [ "api", "campaigns" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"messageTemplate\": {\n \"mode\": \"MMS_PREFERRED\",\n \"text\": \"Hi %%firstname%%, welcome to our campaign!\",\n \"subject\": \"My first campaign\",\n \"unsubscribeText\": \"If you no longer wish to hear from us, reply STOP\",\n \"fallbackText\": \"My first campaign\",\n \"fallbackUnsubscribeText\": \"If you no longer wish to hear from us, reply STOP\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439011\"\n ]\n },\n \"title\": \"My first campaign\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ],\n \"segmentIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ],\n \"accountPhone\": \"8005551234\",\n \"customFieldsMaxLength\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fe02dbb6-6216-431e-90c4-48a47b23ba41", "name": "Get a Campaign", "request": { "name": "Get a Campaign", "description": { "content": "Get a campaign via its unique ID.\n\n**Example:** Below, we return the information associated with the campaign whose ID is `507f1f77bcf86cd799439011`. You can use the [Get all Campaigns](#operation/fetchCampaigns) endpoint to retrieve campaign IDs for all of your campaigns:\n\n`https://api-app2.simpletexting.com/v2/api/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "campaigns", ":campaignId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) Campaign ID in hexadecimal format" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "22243c21-bd1d-405d-bdf6-7eaa84c66c23", "name": "Success. Fetched campaign", "originalRequest": { "url": { "path": [ "api", "campaigns", ":campaignId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "campaignId", "description": "(Required) Campaign ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"accountPhone\": \"8005551234\",\n \"campaignId\": \"607f0558a7c898629dd47d7a\",\n \"lists\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"messageTemplate\": {\n \"text\": \"Hello! How are you?\",\n \"category\": \"MMS\",\n \"subject\": \"Some message from SimpleTexting\",\n \"fallbackText\": \"We sent you a message!\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439333\"\n ]\n },\n \"segments\": [\n {\n \"name\": \"My First List\"\n }\n ],\n \"state\": \"COMPLETED\",\n \"title\": \"My first campaign\",\n \"customFieldsMaxLength\": {\n \"key_0\": 2811,\n \"key_1\": 1783,\n \"key_2\": 9507\n },\n \"type\": \"IMMEDIATELY\",\n \"created\": \"2021-04-28T23:20:08.489Z\",\n \"modified\": \"2021-04-28T23:20:08.489Z\",\n \"started\": \"2021-04-28T23:20:08.489Z\",\n \"finished\": \"2021-04-28T23:20:08.489Z\",\n \"origin\": \"API_V2\",\n \"outcome\": {\n \"successRate\": 100,\n \"optOutRate\": 0,\n \"totalSent\": 1000,\n \"creditsTotal\": 1000\n },\n \"trackingLinks\": [\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n },\n {\n \"url\": \"www.simpletexting.net\",\n \"clickCount\": 550\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21ec60c6-e2bc-4835-baa1-3f6ccb47751c", "name": "Media Items", "description": { "content": "When sending messages via the SimpleTexting platform, you may need to attach various media items. This API allows you to perform various operations needed to manage your media attachments. The size limitations of these items are discussed [here](#tag/File-Information).", "type": "text/plain" }, "item": [ { "id": "b824f5e6-9458-4383-92a9-f6641f5491d5", "name": "Upload Media", "request": { "name": "Upload Media", "description": { "content": "Upload a media file from a local directory to SimpleTexting.\n\n**Example:** Here we upload an image from our local directory using an HTTP request. We state that the media should be shared with teammates:\n\n`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`", "type": "text/plain" }, "url": { "path": [ "api", "mediaitems", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "shared", "value": "true", "description": "Define whether a media file is shared with teammates" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "(Required) The media file you want to upload" } ] } }, "response": [ { "id": "e444fb91-2905-4d27-8db7-80024dd7bdbf", "name": "Success. Media is uploaded.", "originalRequest": { "url": { "path": [ "api", "mediaitems", "upload" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "shared", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The media file you want to upload", "type": "text/plain" }, "key": "file", "value": "", "type": "text" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"607f0558a7c898629dd47d7a\",\n \"createdDate\": \"2021-04-28T23:20:08.489Z\",\n \"name\": \"myfile.jpg\",\n \"gallery\": \"mms\",\n \"size\": 10,\n \"status\": \"PROCESSED\",\n \"link\": \"https://app2.simpletexting.com/content/public-files/607f0558a7c898629dd47d7a\",\n \"contentType\": \"image/png\",\n \"ext\": \"png\",\n \"canDelete\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "62e6bcbe-d754-44c9-b1ab-ec577c41208f", "name": "Upload Media Using a URL", "request": { "name": "Upload Media Using a URL", "description": { "content": "This endpoint allows you to upload media via a URL so that you can send it in a message to a contact.\n\n**Example:** Below we upload some media via a hosted URL to the SimpleTexting system:\n\n`{ \"link\": \"https://dropbox.com/uploads/2019/08/7kAnVTq5Pb9TxEJbBNMDwh-768-80-1.jpg\" }`", "type": "text/plain" }, "url": { "path": [ "api", "mediaitems", "loadByLink" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "shared", "value": "true", "description": "Define whether a media file is shared with teammates" } ], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"link\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8e28a002-fe22-4aec-b7dd-e3ca08f2ada9", "name": "Success. Media is uploaded.", "originalRequest": { "url": { "path": [ "api", "mediaitems", "loadByLink" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "shared", "value": "false" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"link\": \"https://simpletexting.com/wp-content/uploads/2019/08/7kAnVTq5Pb9TxEJbBNMDwh-768-80-1.jpg\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"607f0558a7c898629dd47d7a\",\n \"createdDate\": \"2021-04-28T23:20:08.489Z\",\n \"name\": \"myfile.jpg\",\n \"gallery\": \"mms\",\n \"size\": 10,\n \"status\": \"PROCESSED\",\n \"link\": \"https://app2.simpletexting.com/content/public-files/607f0558a7c898629dd47d7a\",\n \"contentType\": \"image/png\",\n \"ext\": \"png\",\n \"canDelete\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "20aea59f-e281-4593-9140-c069dd5c8fc0", "name": "Get Media Items", "request": { "name": "Get Media Items", "description": { "content": "This endpoint allows you to retrieve all Media Items.\n\n**Example:** Here we return all Media Items from an account:\n\n`https://api-app2.simpletexting.com/v2/api/mediaitems?page=100&size=500`", "type": "text/plain" }, "url": { "path": [ "api", "mediaitems" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "Number of pages" }, { "disabled": false, "key": "size", "value": "50", "description": "Page size" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "c077bf3a-b04d-4514-a4e9-87e280949295", "name": "Success. Returns a page of media items.", "originalRequest": { "url": { "path": [ "api", "mediaitems" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "29" }, { "key": "size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"607f0558a7c898629dd47d7a\",\n \"createdDate\": \"2021-04-28T23:20:08.489Z\",\n \"name\": \"myfile.jpg\",\n \"gallery\": \"mms\",\n \"size\": 10,\n \"status\": \"PROCESSED\",\n \"link\": \"https://app2.simpletexting.com/content/public-files/607f0558a7c898629dd47d7a\",\n \"contentType\": \"image/png\",\n \"ext\": \"png\",\n \"canDelete\": true\n },\n {\n \"id\": \"607f0558a7c898629dd47d7a\",\n \"createdDate\": \"2021-04-28T23:20:08.489Z\",\n \"name\": \"myfile.jpg\",\n \"gallery\": \"mms\",\n \"size\": 10,\n \"status\": \"PROCESSED\",\n \"link\": \"https://app2.simpletexting.com/content/public-files/607f0558a7c898629dd47d7a\",\n \"contentType\": \"image/png\",\n \"ext\": \"png\",\n \"canDelete\": true\n }\n ],\n \"totalPages\": 5521,\n \"totalElements\": 8332\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7be05233-a684-4f21-95cb-6cf1540ce486", "name": "Get Media Item", "request": { "name": "Get Media Item", "description": {}, "url": { "path": [ "api", "mediaitems", ":mediaItemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "mediaItemId", "description": "(Required) Media item ID in hexadecimal format" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "92c331f3-5379-4bbc-877e-ed63169f1491", "name": "Successful. Media item", "originalRequest": { "url": { "path": [ "api", "mediaitems", ":mediaItemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "mediaItemId", "description": "(Required) Media item ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"607f0558a7c898629dd47d7a\",\n \"createdDate\": \"2021-04-28T23:20:08.489Z\",\n \"name\": \"myfile.jpg\",\n \"gallery\": \"mms\",\n \"size\": 10,\n \"status\": \"PROCESSED\",\n \"link\": \"https://app2.simpletexting.com/content/public-files/607f0558a7c898629dd47d7a\",\n \"contentType\": \"image/png\",\n \"ext\": \"png\",\n \"canDelete\": true\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e7981a22-5e10-46e1-a548-4de7b5948dc6", "name": "Delete Media", "request": { "name": "Delete Media", "description": { "content": "Remove media that you have previously uploaded to SimpleTexting.\n\n**Example:** Here we delete a Media Item whose ID is`507f1f77bcf86cd799439011`. You can use the [Get all Media Items](#operation/getMediaItems) endpoint to retrieve Media Items IDs for all of your Media Items:\n\n`https://api-app2.simpletexting.com/v2/api/contact-lists/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "mediaitems", ":mediaItemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "mediaItemId", "description": "(Required) The mediaItemId in hexadecimal format" } ] }, "method": "DELETE", "auth": null }, "response": [ { "id": "656e0e93-cfac-432c-b9f0-0f8191b3645f", "name": "Success. Media was deleted.", "originalRequest": { "url": { "path": [ "api", "mediaitems", ":mediaItemId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "mediaItemId", "description": "(Required) The mediaItemId in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6ae66f6a-baa3-41eb-a10e-04d7f105392a", "name": "Contact Segments", "description": { "content": "Get all of the segments on a given SimpleTexting account.", "type": "text/plain" }, "item": [ { "id": "4f4fe97c-1413-40c8-a9c3-7f7930b48d03", "name": "Get all Segments", "request": { "name": "Get all Segments", "description": { "content": "Retrieves all segments from your SimpleTexting account.\n\n**Example:** Here we return all segments from an account:\n\n`https://api-app2.simpletexting.com/v2/api/contact-segments?page=100&size=2`", "type": "text/plain" }, "url": { "path": [ "api", "contact-segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the segments of the given account). Please note that page numbering starts at zero (`0`)" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned segments to show per page" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5cd1b9dc-b865-4feb-9da1-2da28393c5f5", "name": "Success. Returns all segments from your SimpleTexting account.", "originalRequest": { "url": { "path": [ "api", "contact-segments" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"segmentId\": \"507f191e810c19729de860ea\",\n \"name\": \"string\",\n \"created\": \"2009-12-12T13:21:03.369Z\",\n \"updated\": \"1947-04-18T05:45:21.828Z\"\n },\n {\n \"segmentId\": \"507f191e810c19729de860ea\",\n \"name\": \"string\",\n \"created\": \"1954-02-18T07:52:26.042Z\",\n \"updated\": \"1997-07-03T16:07:45.216Z\"\n }\n ],\n \"totalPages\": 1704,\n \"totalElements\": 1001\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "729ca63c-b380-460d-9545-8ea58b67220f", "name": "Messages", "description": { "content": "In SimpleTexting, users can send and receive messages. With our API, this can be done programmatically.\n\n**Note:** 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](https://help.simpletexting.com/en/articles/3362741-why-carriers-don-t-allow-bit-ly-and-other-third-party-link-shorteners).", "type": "text/plain" }, "item": [ { "id": "883058ba-3711-485b-bacc-89123be043f7", "name": "Get all Messages", "request": { "name": "Get all Messages", "description": { "content": "Retrieves a list of all messages sent to a specific contact from a specific number on your account.\n\n**Example:** Here we return all messages from an account:\n\n`https://api-app2.simpletexting.com/v2/api/messages?page=100&size=500`", "type": "text/plain" }, "url": { "path": [ "api", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the messages of the given number). Please note that page numbering starts at zero (`0`)" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned messages to show per page" }, { "disabled": false, "key": "accountPhone", "value": "", "description": "The phone number on your account the messages were sent to. If blank, the request will return the messages sent to the primary account phone" }, { "disabled": false, "key": "since", "value": "", "description": "First sent/received timestamp. The time is in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format." }, { "disabled": false, "key": "contactPhone", "value": "", "description": "The contact's phone number" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "046344bf-c92a-4d57-bf74-3f358a695fa3", "name": "Success. Returns a list of messages.", "originalRequest": { "url": { "path": [ "api", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "25" }, { "key": "size", "value": "50" }, { "key": "accountPhone", "value": "" }, { "key": "since", "value": "2021-04-28T23:20:08.489Z" }, { "key": "contactPhone", "value": "" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"id\": \"507f191e810c19729de860ea\",\n \"subject\": \"Some message from SimpleTexting\",\n \"text\": \"Hello! How are you?\",\n \"contactPhone\": \"8001234567\",\n \"accountPhone\": \"8005551234\",\n \"directionType\": \"MO\",\n \"timestamp\": \"2020-04-28T23:20:08.489Z\",\n \"referenceType\": \"API_SEND\",\n \"category\": \"SMS\",\n \"mediaItems\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439333\"\n ]\n },\n {\n \"id\": \"507f191e810c19729de860ea\",\n \"subject\": \"Some message from SimpleTexting\",\n \"text\": \"Hello! How are you?\",\n \"contactPhone\": \"8001234567\",\n \"accountPhone\": \"8005551234\",\n \"directionType\": \"MO\",\n \"timestamp\": \"2020-04-28T23:20:08.489Z\",\n \"referenceType\": \"API_SEND\",\n \"category\": \"SMS\",\n \"mediaItems\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439333\"\n ]\n }\n ],\n \"totalPages\": 8337,\n \"totalElements\": 4364\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "bb002a3f-c694-4ec4-b14e-a48209fc61d4", "name": "Send a Message", "request": { "name": "Send a Message", "description": { "content": "Send either an MMS or SMS message to a contact. Use this programmatically to send to multiple contacts.\n\nIf the message contains a link from a common third-party link shortener such as [bit.ly](http://bit.ly/), it will appear from our URL shortener instead and occupy 20 characters. [Learn more](https://help.simpletexting.com/en/articles/3362741-why-carriers-don-t-allow-bit-ly-and-other-third-party-link-shorteners).\n\nThere are limitations on Media Files with MMS messages. The size limitations of these items are discussed [here](#tag/File-Information).\n\n**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:\n\n`{ \"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\" ] }`", "type": "text/plain" }, "url": { "path": [ "api", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"\",\n \"mode\": \"\",\n \"text\": \"\",\n \"accountPhone\": \"\",\n \"subject\": \"\",\n \"fallbackText\": \"\",\n \"mediaItems\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "c5b89706-3e9e-4784-ad4f-8fefc0ad4b12", "name": "Successful. Message was created.", "originalRequest": { "url": { "path": [ "api", "messages" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactPhone\": \"1234567890\",\n \"mode\": \"MMS_PREFERRED\",\n \"text\": \"Hello! How are you?\",\n \"accountPhone\": \"8005551234\",\n \"subject\": \"Some message from SimpleTexting\",\n \"fallbackText\": \"[url=%%fallback_link%%]\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439011\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\",\n \"credits\": 3925\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a8722d9c-dcca-4e04-b776-f237ce1587c0", "name": "Evaluate a Message", "request": { "name": "Evaluate a Message", "description": { "content": "Evaluate the body of your message before sending it to a contact or contacts.\n\n**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:\n\n`https://api-app2.simpletexting.com/v2/api/messages/evaluate`", "type": "text/plain" }, "url": { "path": [ "api", "messages", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"text\": \"\",\n \"subject\": \"\",\n \"fallbackText\": \"\",\n \"mediaItems\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "808ba647-1323-492e-9049-3ca76f07bfba", "name": "Success. You have a message to evaluate.", "originalRequest": { "url": { "path": [ "api", "messages", "evaluate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"mode\": \"MMS_PREFERRED\",\n \"text\": \"Hello! How are you?\",\n \"subject\": \"New In Store\",\n \"fallbackText\": \"[url=%%fallback_link%%]\",\n \"mediaItems\": [\n \"https://txt.so/img.jpg\",\n \"507f1f77bcf86cd799439011\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"detectedCategory\": \"SMS\",\n \"length\": 134,\n \"remains\": 23,\n \"maxLength\": 150,\n \"unicode\": true,\n \"sumOfCredits\": 1,\n \"warnings\": [\n \"Text is blank\",\n \"Text is blank\"\n ],\n \"errors\": [\n \"Invalid phone number\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8ed83e58-9156-4583-b485-2aa3ec4c6978", "name": "Get a Message", "request": { "name": "Get a Message", "description": { "content": "Retrieve a specific message from the system via its message ID.\n\n**Example:** Below, we return the information associated with the message whose ID is `507f1f77bcf86cd799439011`. You can use the [Get all Messages](#operation/getMessages) endpoint to retrieve message IDs for all of your messages:\n\n`https://api-app2.simpletexting.com/v2/api/messages/507f1f77bcf86cd799439011`", "type": "text/plain" }, "url": { "path": [ "api", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "messageId", "description": "(Required) Message ID in hexadecimal format" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e8a49cec-6d3e-4293-9a22-d2848d6f4b74", "name": "Success. Retrieved a message.", "originalRequest": { "url": { "path": [ "api", "messages", ":messageId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "messageId", "description": "(Required) Message ID in hexadecimal format" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\",\n \"subject\": \"Some message from SimpleTexting\",\n \"text\": \"Hello! How are you?\",\n \"contactPhone\": \"8001234567\",\n \"accountPhone\": \"8005551234\",\n \"directionType\": \"MO\",\n \"timestamp\": \"2020-04-28T23:20:08.489Z\",\n \"referenceType\": \"API_SEND\",\n \"category\": \"SMS\",\n \"mediaItems\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439333\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "0cc247c5-e371-4064-ad97-9c4e76e0613d", "name": "File Information", "description": { "content": "We can accept a wide variety of file types over MMS. The industry standard maximum file\nsize limit is `600KB` for toll-free accounts and is `1MB` on shortcode accounts.\n\n\nWe support the following file type: `MPEG Audio, MPEG Video, MP4 Video, VCARDs, PDF`\n\n\nFor popular image types we can accept media up to `15MB`, our system will automatically\ncompress these to the `600KB` industry limitation. These media types include: `JPEG, PNG, GIF`\n", "type": "text/plain" }, "item": [], "event": [] }, { "id": "9b224946-11af-4b2b-a04a-ace49e62113f", "name": "Custom Fields", "description": { "content": "SimpleTexting's Custom Fields feature plays a key role in managing your customer data. Not only does it give you enormous flexibility when it comes to [collecting](https://help.simpletexting.com/using-simpletexting/apps-and-features/collecting-subscriber-data) or [importing](https://help.simpletexting.com/using-simpletexting/lists-and-contacts/importing-contacts) data, it also lets you quickly and easily personalize each message in a [mass text](https://simpletexting.com/mass-texting/) campaign.", "type": "text/plain" }, "item": [ { "id": "73749267-af13-48ed-a63d-bd1ed2a250e3", "name": "Get all Custom Fields", "request": { "name": "Get all Custom Fields", "description": { "content": "This endpoint allows you to retrieve all custom fields.\n\n**Example:** Here we return all Custom Fields from an account:\n\n`https://api-app2.simpletexting.com/v2/api/custom-fields?page=100&size=500`", "type": "text/plain" }, "url": { "path": [ "api", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "An ordinal number of the page to return with the results of a request (with the custom fields of the given account). Please note that page numbering starts at zero (`0`)\n\n\n**Example:** `40`" }, { "disabled": false, "key": "size", "value": "50", "description": "The number of the returned custom fields to show per page\n\n**Example:** `50`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "82337018-08ee-4362-9990-e1b2cde41b8d", "name": "Success. All custom fields retrieved.", "originalRequest": { "url": { "path": [ "api", "custom-fields" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "40" }, { "key": "size", "value": "50" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"label\": \"My Custom Field\",\n \"type\": \"text\",\n \"mergeTag\": \"my_custom_field\",\n \"defaultMaxLength\": 30\n },\n {\n \"label\": \"My Custom Field\",\n \"type\": \"text\",\n \"mergeTag\": \"my_custom_field\",\n \"defaultMaxLength\": 30\n }\n ],\n \"totalPages\": 6818,\n \"totalElements\": 5281\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "79b77d8f-64db-43cd-b2c4-db76f0b055ea", "name": "Contacts - Batch Operations", "description": { "content": "An endpoint to assist in batch operations on your contacts. Using these operations, you can update specific contact information, or delete contacts, all using the contacts phone as an ID.", "type": "text/plain" }, "item": [ { "id": "9d2908c7-e2fd-47fd-8985-04bf0f396433", "name": "Update a Group of Contacts", "request": { "name": "Update a Group of Contacts", "description": { "content": "Update multiple fields at once for a batch of contacts. You can update their first name, last name, emails, lists, and more.\n\n**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:\n\n`{ \"updates\": [ { \"contactPhone\": \"1234567890\", \"firstName\": \"John\", \"lastName\": \"Doe\", \"email\": \"john.doe@simpletexting.net\", \"birthday\": \"1985-05-15\", \"customFields\": { \"zipcode\": \"12345\" }, \"comment\": \"VIP client\", \"listIds\": [ \"507f191e810c19729de860ea\", \"My First List\" ] },{ \"contactPhone\": \"0987654321\", \"firstName\": \"Jane\", \"lastName\": \"Doe\", \"email\": \"jane.doe@simpletexting.net\", \"birthday\": \"1984-05-25\", \"customFields\": { \"zipcode\": \"54321\" }, \"comment\": \"VIP client\", \"listIds\": [ \"507f191e810c19729de860ea\", \"My First List\" ] } ], \"listsReplacement\": true }`\n\nStep 1: Start the task for the batch update with the above parameters. As a result, you receive the task ID.\n\nExample:\n\n`{ \"id\": \"6176fb3e141c0060668b2c03\" }`\n\nStep 2: Request the task result by adding task ID from Step 1 to the [Get update result](#operation/getBatchUpdateResults) request.\n\nExample:\n\n`{\n \"status\": \"DONE\",\n \"results\":\n[{ \"done\": true,\n \"contactPhone\": \"1234567890\",\n \"contactId\": \"6176f999141c0060668b258e\" },\n{ \"done\": true,\n\"contactPhone\": \"0987654321\",\n\"contactId\": \"1236f555141c0060668b123e\"}],\n\"requestedCount\": 2,\n\"processedCount\": 2\n}`", "type": "text/plain" }, "url": { "path": [ "api", "contacts-batch", "batch-update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n },\n {\n \"contactPhone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"email\": \"\",\n \"birthday\": \"\",\n \"customFields\": {\n \"Merge tag\": \"\"\n },\n \"comment\": \"\",\n \"listIds\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"listsReplacement\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "721af5c9-f337-440f-a4bf-919930ef8f3b", "name": "Success. Contacts were successfully updated.", "originalRequest": { "url": { "path": [ "api", "contacts-batch", "batch-update" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"updates\": [\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n },\n {\n \"contactPhone\": \"1234567890\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@simpletext.org\",\n \"birthday\": \"1985-05-15\",\n \"customFields\": {\n \"zipcode\": \"12345\"\n },\n \"comment\": \"VIP client\",\n \"listIds\": [\n \"507f191e810c19729de860ea\",\n \"My First List\"\n ]\n }\n ],\n \"listsReplacement\": true\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"507f191e810c19729de860ea\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d9f1dedc-f746-44eb-b437-31b71bc74a6f", "name": "Delete a Group of Contacts", "request": { "name": "Delete a Group of Contacts", "description": { "content": "Delete a group of contacts from SimpleTexting using their phone numbers.\n\n**Example:** Below, we delete a batch of contacts identified here by their phone number in the array:\n\n`{ \"contactPhones\": [ \"1234567890\", \"0987654321\", \"1122334455\" ] }`", "type": "text/plain" }, "url": { "path": [ "api", "contacts-batch", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"contactPhones\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "191fa36a-68b0-487b-8787-46f19d230835", "name": "Success. Contacts were successfully deleted.", "originalRequest": { "url": { "path": [ "api", "contacts-batch", "batch-delete" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"contactPhones\": [\n \"1234567890\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": [\n {\n \"done\": true,\n \"contactPhone\": \"1234567890\",\n \"contactId\": \"507f1f77bcf86cd799439011\",\n \"errorCode\": \"UNKNOWN_CONTACT_PHONE\",\n \"errorMessage\": \"Contact with provided phone number is missing\"\n },\n {\n \"done\": true,\n \"contactPhone\": \"1234567890\",\n \"contactId\": \"507f1f77bcf86cd799439011\",\n \"errorCode\": \"UNKNOWN_CONTACT_PHONE\",\n \"errorMessage\": \"Contact with provided phone number is missing\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cb6b1e00-2064-4551-b63a-832dc8e775ab", "name": "Get the Result of a Batch Update Task", "request": { "name": "Get the Result of a Batch Update Task", "description": { "content": "Return the result of a batch update by the task id.", "type": "text/plain" }, "url": { "path": [ "api", "contacts-batch", "batch-update", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "taskId", "description": "(Required) The ID of the task for the batch update\n\n**Example:** `6176fb3e141c0060668b2c03`" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "df8fc77b-1646-470a-8ea4-594c383daae7", "name": "Success. Contacts were successfully updated.", "originalRequest": { "url": { "path": [ "api", "contacts-batch", "batch-update", ":taskId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "taskId", "description": "(Required) The ID of the task for the batch update\n\n**Example:** `6176fb3e141c0060668b2c03`" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"IN_PROGRESS\",\n \"results\": [\n {\n \"done\": true,\n \"contactPhone\": \"1234567890\",\n \"contactId\": \"507f1f77bcf86cd799439011\",\n \"errorCode\": \"CONTACT_CREATE_FAILED\",\n \"errorMessage\": \"Contacts limit is reached\"\n },\n {\n \"done\": true,\n \"contactPhone\": \"1234567890\",\n \"contactId\": \"507f1f77bcf86cd799439011\",\n \"errorCode\": \"CONTACT_CREATE_FAILED\",\n \"errorMessage\": \"Contacts limit is reached\"\n }\n ],\n \"requestedCount\": 400,\n \"processedCount\": 400\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "95e8f02c-49ed-4b15-bff0-90c73b9262c0", "name": "Tenant", "description": { "content": "General information about account", "type": "text/plain" }, "item": [ { "id": "0b2610d2-9f3e-4398-b465-30cf16827c76", "name": "Get general information", "request": { "name": "Get general information", "description": { "content": "Retrieves a general information about account.", "type": "text/plain" }, "url": { "path": [ "api", "tenant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "161bf55f-809e-4b0d-b0ba-79bf014fb1bd", "name": "Success. Returns a list of messages.", "originalRequest": { "url": { "path": [ "api", "tenant" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"email\": \"owner@example.com\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a38565f2-e9c8-4194-8629-67ceaedbea76", "name": "Webhook Reports", "description": { "content": "Use webhooks to communicate between the SimpleTexting platform and your server. Webhooks can be used to forward messages as well as provide info about unsubscribes and message delivery. SimpleTexting can trigger webhooks for new incoming messages, delivery reports and unsubscribes.", "type": "text/plain" }, "item": [ { "id": "a8a240ff-fa66-4843-8014-179540a3ecdf", "name": "Unsubscribe Report", "request": { "name": "Unsubscribe Report", "description": { "content": "Triggers when a client sends STOP to your number.\n\n**Example:** We create the Unsubscribe report for `8005551234` for the status of the outgoing messages to `8001234567`:\n\n`{\"url\": \"http://www.yourdomain.com/unsubscribe.php\",\"triggers\": [\"UNSUBSCRIBE_REPORT\"],\"requestPerSecLimit\": 25,\"accountPhone\": \"8005551234\",\"contactPhone\": \"8001234567\"}`\n\nYour 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.", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "", "report", "unsubscribe" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reportId\": \"\",\n \"webhookId\": \"\",\n \"type\": \"\",\n \"values\": {\n \"contactId\": \"\",\n \"phone\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "b581ebe5-e870-42c4-b9de-557e3e5d2791", "name": "OK", "originalRequest": { "url": { "protocol": "https", "path": [ "", "report", "unsubscribe" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"507f191e810c19729de860ea\",\n \"webhookId\": \"507f191e810c19729de860ea\",\n \"type\": \"UNSUBSCRIBE_REPORT\",\n \"values\": {\n \"contactId\": \"507f191e810c19729de860ea\",\n \"phone\": \"8001234567\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "23bd00d7-9c73-4fbb-a889-08c45021345d", "name": "Incoming/Outgoing Message Report", "request": { "name": "Incoming/Outgoing Message Report", "description": { "content": "Triggers when an outgoing message or incoming message is handled.\n\n**Example:** We create the incoming webhook for `8005551234` from contact phone `8001234567`:\n\n`{\"url\": \"http://www.yourdomain.com/receivesms.php\",\"triggers\": [\"INCOMING_MESSAGE\"],\"requestPerSecLimit\": 25,\"accountPhone\": \"8005551234\",\"contactPhone\": \"8001234567\"}`", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "", "report", "incoming" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reportId\": \"\",\n \"webhookId\": \"\",\n \"type\": \"\",\n \"values\": {\n \"messageId\": \"\",\n \"subject\": \"\",\n \"mediaItems\": [\n \"\",\n \"\"\n ],\n \"text\": \"\",\n \"accountPhone\": \"\",\n \"contactPhone\": \"\",\n \"timestamp\": \"\",\n \"category\": \"\",\n \"referenceType\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0189491a-2b61-4277-bb72-c649ba45d28d", "name": "OK", "originalRequest": { "url": { "protocol": "https", "path": [ "", "report", "incoming" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"507f191e810c19729de860ea\",\n \"webhookId\": \"507f191e810c19729de860ea\",\n \"type\": \"UNSUBSCRIBE_REPORT\",\n \"values\": {\n \"messageId\": \"507f191e810c19729de860ea\",\n \"subject\": \"Some message from SimpleTexting\",\n \"mediaItems\": [\n \"507f1f77bcf86cd799439011\",\n \"507f1f77bcf86cd799439333\"\n ],\n \"text\": \"Hello! How are you?\",\n \"accountPhone\": \"8005551234\",\n \"contactPhone\": \"8001234567\",\n \"timestamp\": \"2020-04-28T23:20:08.489Z\",\n \"category\": \"SMS\",\n \"referenceType\": \"API\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8769530a-949a-47db-ba35-01c108361aa2", "name": "Delivery/Non Delivered Message Report", "request": { "name": "Delivery/Non Delivered Message Report", "description": { "content": "Triggers when an outgoing message is reported as delivered or undelivered by the carrier.\n\n**Example:** We create the Delivery report for `8005551234` for the status of the outgoing messages to `8001234567`:\n\n`{\"url\": \"http://www.yourdomain.com/delivery.php\",\"triggers\": [\"DELIVERY_REPORT\"],\"requestPerSecLimit\": 25,\"accountPhone\": \"8005551234\",\"contactPhone\": \"8001234567\"}`\n\nYour 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.", "type": "text/plain" }, "url": { "protocol": "https", "path": [ "", "report", "delivery" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"reportId\": \"\",\n \"webhookId\": \"\",\n \"type\": \"\",\n \"values\": {\n \"messageId\": \"\",\n \"category\": \"\",\n \"referenceType\": \"\",\n \"accountPhone\": \"\",\n \"contactPhone\": \"\",\n \"carrier\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3dc35bc8-c413-46c8-9b23-6aab215a4452", "name": "OK", "originalRequest": { "url": { "protocol": "https", "path": [ "", "report", "delivery" ], "host": [ "yourdomain", "com" ], "query": [], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reportId\": \"507f191e810c19729de860ea\",\n \"webhookId\": \"507f191e810c19729de860ea\",\n \"type\": \"UNSUBSCRIBE_REPORT\",\n \"values\": {\n \"messageId\": \"507f191e810c19729de860ea\",\n \"category\": \"SMS\",\n \"referenceType\": \"API\",\n \"accountPhone\": \"8005551234\",\n \"contactPhone\": \"8001234567\",\n \"carrier\": \"Verizon\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "ad185cd6-c47c-47a4-ae83-e9510b76da6d", "name": "Tenant phones", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "de1fd322-f386-420d-a20f-f5eace0adc90", "name": "Get all phones", "request": { "name": "Get all phones", "description": { "content": "Retrieve all phone numbers for account.", "type": "text/plain" }, "url": { "path": [ "api", "phones" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "0", "description": "The number of phone numbers returned with each request\n\n**Example:** `250`" }, { "disabled": false, "key": "size", "value": "50", "description": "The size of the page\n\n**Example:** `150`" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "8247db14-b65d-41b5-b553-9eab0df7fd6d", "name": "Success. Returns a paginated list of contacts.", "originalRequest": { "url": { "path": [ "api", "phones" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "250" }, { "key": "size", "value": "150" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"content\": [\n {\n \"number\": \"1234567890\",\n \"name\": \"Primary phone\"\n },\n {\n \"number\": \"1234567890\",\n \"name\": \"Primary phone\"\n }\n ],\n \"totalPages\": 9308,\n \"totalElements\": 5459\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-app2.simpletexting.com/v2", "key": "baseUrl" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "Authorization" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] }, "info": { "_postman_id": "c1238ed4-b5d4-4508-b0f5-dcecb068212b", "name": "SimpleTexting API Documentation", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "# Introduction\n\n\nThousands of businesses rely on SimpleTexting to communicate with their audience via text message. With our API, developers can access many of our platform’s features and integrate them with other websites or applications. This document details the available SimpleTexting API functions and their parameters. For additional security, our API is by approval only. If you’d like access, sign up for a trial account and email [support@simpletexting.net](mailto:support@simpletexting.net) with details about your use case.\n\n**How it works**\n\nOur API is organized around [REST](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard HTTP response codes and authentication. Before you get started, there a few things to keep in mind:\n\n- When using the POST request, you must specify that `content-type` is `application/json`.\n\n\n- The format of responses for all requests is JSON, you can skip the `Accept` request header or set it to `application/json`.\n\n# Authentication\n\nEach time you make a request to our API, we use a bearer token in your header to authenticate your account. API requests without authentication will fail. Your API token can be found under [settings](https://app2.simpletexting.com/integrations/webhooks).

\nPlease be sure to keep your bearer token secure. Don’t share it any public areas such as GitHub, client-side code, etc.\n\n\n", "type": "text/plain" } } }