Welcome to Text-Em-All's REST API Developer's Guide. We've put together a simple reference guide for your use. Like any good guide it describes the API functions and tells you how to connect and make use of our service. In short, there's lots of good stuff in here that will help you get the most out of the Text-Em-All API.
\nThe Developer's Guide consists of instructions for setting up your integration, provisioning new accounts/users, API Requests/Authentication/Responses, and basic functions. Additional functions may be available depending on the level of your integration.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12697789","collectionId":"0a973adc-c095-4ebb-82e9-5684c99f011c","publishedId":"TVYNYF8V","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-11-20T20:23:14.000Z"},"item":[{"name":"Setup","item":[],"id":"4af7acc3-5a3a-4773-a568-c37653336813","description":"We require all API accounts to be on the Pay-As-You-Go plan. Unfortunately, we do not offer API access to monthly customers. If you have any questions please feel free to contact us.
\nTo set up an integration with Text-Em-All you need to do the following:
\nCreate a Free Trial account at https://www.text-em-all.com. The Free Trial lives in our production environment.
\nContact support@text-em-all.com to get a new integration created for you. Please let us know about the Free Trial account you created.
\nWe will create a mirror image of your account in our production environment for your testing purposes.
\nWe will send you back an Application Key and a Secret Key for your test account. You'll use them for API authentication while you develop and test. We'll also drop some credits into your test account.
\nWhen you have completed development, notify us and we will review your test environment work. If approved, we will send you Application and Secret keys for your Free Trial production account.
\nIf you haven't done so already, buy credits for your Free Trial account. This converts it into a Pay-As-You-Go account. You may also ask us to bill the account in arrears.
\nUse your production account thereafter for all of your Text-Em-All business. You can still test and develop using your test account.
\nWhen a new Text-Em-All account is created, an account owner user is also created. Additional users can be created manually after logging into the account, or programmatically via the API.
\nUsers make API calls. No matter the user type, the user making the call must present his or her own unique Authentication Token. The computation of the request's OAuth signature requires it, as explained in the Authentication section. A user's Authentication Token can be obtained using the API with a POST to the Login User endpoint.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"183d7d57-2f3b-425d-b90b-0a3340de5e81","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c4c95226-3433-4488-a3df-4ba4ab2dbf76","type":"text/javascript","exec":[""]}}],"_postman_id":"4af7acc3-5a3a-4773-a568-c37653336813"},{"name":"API Basics","item":[{"name":"API Requests","item":[],"id":"b05d4538-b84c-42e4-903a-a1441e671f1a","description":"The base URL for all production and test endpoints start with: https://rest.text-em-all.com/v1.
\nThe API endpoints can only be accessed through HTTPS and should be encrypted using TLS 1.2 or higher. All requests via HTTP will result in an error, returning status code 403 - Forbidden.
\nIn most cases, request and response bodies will contain some data. This data must be formatted as JSON. Set the Accept and Content-Type headers of your requests to application/json as shown in the code sample below. Sometimes a request may need to send, or a response return, something other than JSON (e.g., when uploading or downloading files). In such cases, we'll let you know what headers to use and how to submit the data and handle the response.
\nHeaders\n{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\",\n \"Content-Length\": ...,\n ....\n}\n\nThe API uses standard OAuth version 1 for authentication. Under OAuth, the Application and Secret keys for the account and Authorization Token of the user making the request are combined with other information unique to the request to produce a set of values (the OAuth signature). The OAuth signature is unique to each request and must be generated afresh for each request. Add the signature in the Authorization header in all of your requests as shown in the example header fragment below. Requests with a bad signature will return the HTTP response code 400 – Bad Request. Information about OAuth version 1, including code libraries for many languages, can be found at OAuth.net.
Headers\n{\n ....\n \"Authorization\": \"OAuth oauth_consumer_key=\"....\"oauth_token=\"....\"oauth_nonce=\"....\"oauth_timestamp=\"....\"oauth_signature_method=\"HMAC-SHA1\"oauth_version=\"1.0\"oauth_signature=\"....\"\",\n ....\n}An API request will return an HTTP status code and one of the following type of data in the response body.
\nA collection/feed of resources
\nAn error object
\nResponses to unsuccessful requests will return non-2xx HTTP status code. If the request failed gracefully, the response body will contain an Error resource model in JSON with the keys and value types shown below. The values will differ for each error.
{\n \"ErrorCode\": 200,\n \"ErrorType\": \"Informational\",\n \"Message\": \"CreateDate cannot be used as a search parameter.\",\n}Otherwise, the response body's content will be indeterminate. Most likely it will be HTML or plain text.
\nWe recommend that you try parse the response body as JSON. If successful, you can use the extracted information to make decisions about what your code should do next.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"d49a97dc-c604-4b72-82c8-2aed7df7ed0e"},{"name":"Searching","item":[],"id":"e70d869e-5edb-4404-9f9b-db1d5610ebac","description":"You can use search parameters for API endpoints that return a collection of resources. Each endpoint lists the search fields it supports.
\nSearch parameters are just query parameters, so separate them with the ’&’ sign just like you would for any query parameter.
\nA search parameter has the pattern <fieldname><comparator><value>. For example, to filter for broadcasts having start dates prior to 2014-01-02, use the search parameter StartDate~lt~2014-01-02.
The following comparators are available. Each endpoint lists the comparators it supports.
\n| Comparator | \nDescription | \n
| = | \nequals | \n
| ~lt~ | \nless than | \n
| ~lte~ | \nless than or equal | \n
| ~gt~ | \ngreater than | \n
| ~gte~ | \ngreater than or equal | \n
GET /broadcasts?StartDate~gte~2014-01-01&StartDate~lt~2014-01-02&BroadcastStatus=CompletedUse the sortby parameter to give one or a list of fields to order the result by as you need it. Use comma to separate the sorting field names and a preceding dash sign for any to indicated descending sort. Please refer to the documentation of each endpoint for fields that you can use to sort by.
\nGET /broadcasts?sortby=-StartDate,-CreateDateWhen an endpoint has the potential to return a collection of objects, the API requires the use of pagination. In pagination, the collection of objects is divided into pages, each page containing a certain number of objects from the collection (the \"page size\").
\nIn its query string, the request can specify a page size and which page it wants. The table below shows the pagination query string parameters and their default values. All three parameters are optional.
\n| page={p} | \nThe page of items to return. Default = 1. | \n
| pagesize={n} | \nThe maximum number of items per page. Default = 10. | \n
| takesize={t} | \nHow many items to return. [Equal to pagesize if omitted.] | \n
The response data will indicate total number of objects in the collection via the Size key. Returned objects will be in the Items array. The size of the Items array will be less than or equal to the request's page size. When no qualifying objects are found, the Items will be empty array. Be sure to allow for this possibility.
The response will also provide URIs for the next and previous pages, if any, based on request's page number and page size, the number of objects in the collection, and any other query parameters in the request. Use these URIs to request the previous or next page of results without any computation on your part.
\nThe example below shows portion of the URI for a GET request for the broadcasts endpoint. It filters broadcasts by start date and created date, sorts the results by the created date in descending order, and asks for only one result per page (pagesize=1). Because page is omitted, its value defaults to 1.
In the response JSON, we see that there are five broadcasts meeting the filter conditions. Because pagesize=1 and broadcasts are sorted in descending order of their creation dates, only one broadcast record is in the Items array and it's the oldest of the five. This is the first page of a possible five pages. Thus, a Previous page URL can't exist. A Next page URI is provided. Notice that it retains all the query parameters of the request and adds a page=2 parameter.
/broadcasts?StartDate~gte~2014-01-01&CreatedDate~gte~2014-01-01&sortby=-CreatedDate&pagesize=1{\n \"Size\": 5,\n \"Items\": \n [\n {\n \"Uri\": \"/v1/broadcasts/23718\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/23718/details\",\n \"BroadcastName\": \"Test Broadcast\",\n \"BroadcastType\": \"Announcement\",\n \"BroadcastStatus\": \"Complete\",\n \"CreatedDate\": \"2014-02-24 15:54:12-0600\",\n \"StartDate\": \"2014-02-24 15:54:13-0600\",\n \"CallerID\": \"9725551212\",\n \"CreditsUsed\": 1.00,\n \"PhoneNumberCount\": 1,\n \"TotalCompleted\": 1,\n \"RetryTimes\": 1,\n \"CallThrottle\": 0,\n \"LivePersonTotal\": 1,\n \"AnsweringMachineTotal\": 0,\n \"BusyNoAnswerTotal\": 0,\n \"InvalidNumberTotal\": 0,\n \"SurveyResponseTotal\": 0,\n \"SurveyResponses\": null,\n }\n ],\n \"Previous\": null,\n \"Next\": \"/broadcasts?StartDate~gte~2014-01-01&CreatedDate~gte~2014-01-01&sortby=-CreatedDate&pagesize=1&page=2\",\n}To manage system load and prevent resource hogging, the API limits your request rate. Requests which exceed the limit will receive HTTP status code 503 – Service Unavailable.
You can reduce the chances of exceeding the limit by programming smartly. For example, cache and reuse user authentication tokens until they expire (see the Login User endpoint description for more info). Or, instead of polling for broadcast statuses or new text messages using API requests, subscribe to our notification service and let us push updates to you programmatically.
\nPlease email api@text-em-all.com if you are concerned about the request rate or would like tips on reducing it.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"f15e6dd6-e1c5-404a-bc24-cf3700956386"}],"id":"09585e7f-1ec2-43a8-8f2f-670b02a2f783","auth":{"type":"noauth","isInherited":false},"_postman_id":"09585e7f-1ec2-43a8-8f2f-670b02a2f783","description":""},{"name":"API Endpoints","item":[{"name":"Account","item":[{"name":"Get Account Information","id":"aa891f65-1735-47fc-b2f3-aa81716f2e58","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"The Response contains anAccountmodel.
","urlObject":{"path":["v1","account"],"host":["{{base_url}}"],"query":[{"disabled":true,"key":"include","value":"currentuser"},{"disabled":true,"key":"include","value":null}],"variable":[]}},"response":[{"id":"15882e87-9baf-45ad-8b27-2d0418372c24","name":"Get Account Information Response","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{base_url}}/v1/account","host":["{{base_url}}"],"path":["v1","account"],"query":[{"key":"include","value":"currentuser","disabled":true},{"key":"include","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 04 Jun 2021 20:16:49 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": null,\n \"AccountID\": 11111,\n \"MonthlyLevel\": 0,\n \"MonthlyFee\": 0,\n \"SubscriptionEndDate\": \"2021-02-25 00:00:00-0600\",\n \"GroupCode\": \"\",\n \"Created\": \"2020-10-01 17:48:31.417-0500\",\n \"CompanyName\": \"Text-Em-All Pay-As-You-Go\",\n \"Address1\": \"3803 Parkwood Blvd\",\n \"Address2\": \"Ste 900\",\n \"City\": \"Frisco\",\n \"State\": \"TX\",\n \"Zip\": \"75034\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": null,\n \"CallBalance\": 2979,\n \"UniqueCallCount\": 0,\n \"AvailableCallUnits\": 2979,\n \"PendingCallBalance\": 0,\n \"MessengerCount\": 1,\n \"RequireTextOptIn\": false\n}"}],"_postman_id":"aa891f65-1735-47fc-b2f3-aa81716f2e58"},{"name":"Update Account Information","id":"134c3da8-0525-4229-ac6f-66fc78399cc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The endpoint allows you to change these account properties:
\n\n| Property | Description |
|---|---|
string CompanyName | The billing company name. |
string Address1 | The first line of the billing address for the company. |
string Address2 | The second line of the billing address for the company. |
string City | The billing address's city. |
string State | The billing address's state. |
string Zip | The billing address's zip code. |
The response body contains theAccountmodel with the updated properties.
","urlObject":{"path":["v1","account"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"9b752ecc-2e9b-42d6-a6c1-b513cd773e29","name":"Update Account Response Monthly","originalRequest":{"method":"PUT","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyName\": \"Text-Em-All Monthly\",\r\n \"State\": \"TX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"489"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcYWNjb3VudA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 02 Oct 2020 22:24:38 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": null,\n \"AccountID\": 63310,\n \"MonthlyLevel\": 100,\n \"MonthlyFee\": 35,\n \"SubscriptionEndDate\": \"2020-11-02 00:00:00-0500\",\n \"GroupCode\": \"\",\n \"Created\": \"2020-10-01 17:32:14.787-0500\",\n \"CompanyName\": \"Text-Em-All Monthly\",\n \"Address1\": \"3803 Parkwood Blvd\",\n \"Address2\": \"Suite 900\",\n \"City\": \"Frisco\",\n \"State\": \"TX\",\n \"Zip\": \"75034\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": null,\n \"CallBalance\": 0,\n \"UniqueCallCount\": 0,\n \"AvailableCallUnits\": 0,\n \"PendingCallBalance\": 0,\n \"MessengerCount\": 0,\n \"RequireTextOptIn\": false\n}"},{"id":"ff3537a8-7369-4dca-a321-87ea1cb64337","name":"Update Account Response Pay-As-You-Go","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"CompanyName\": \"Text-Em-All\",\r\n \"State\": \"TX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"587"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcYWNjb3VudA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 02 Oct 2020 16:45:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": null,\n \"AccountID\": 51599,\n \"MonthlyLevel\": 25,\n \"MonthlyFee\": 7.5,\n \"SubscriptionEndDate\": \"2020-11-01 00:00:00-0500\",\n \"GroupCode\": \"ford\",\n \"Created\": \"2016-05-13 09:12:57.5-0500\",\n \"CompanyName\": \"Text-Em-All\",\n \"Address1\": \"3803 Parkwood Blvd.\",\n \"Address2\": \"Suite 900\",\n \"City\": \"Frisco\",\n \"State\": \"TX\",\n \"Zip\": \"75034\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"Thanks for joining our text alerts. You can obtain help by visiting https://support.text-em-all.com/\",\n \"CallBalance\": 3003.5,\n \"UniqueCallCount\": 0,\n \"AvailableCallUnits\": 3003.5,\n \"PendingCallBalance\": 0,\n \"MessengerCount\": 38,\n \"RequireTextOptIn\": false\n}"}],"_postman_id":"134c3da8-0525-4229-ac6f-66fc78399cc9"},{"name":"Get All Account Users","id":"8888b8ee-863d-40c3-9429-360f279c36b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"Using this endpoint a account owner can get a list of users associated with the account. Adding ?include=currentuser will include the user making the request.
The request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your users with this search string. [Searches: username, email, first name and last name] | \n
| sortby | \nsortby=firstnamelastname | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-firstnamelastname] | \n
| include | \ninclude=currentuser | \nBy default, only users other than yourself will be returned. You can include your user in the results by adding this parameter. | \n
| enabled | \nenabled=true | \nReturns all users who are active. | \n
| disabled | \ndisabled=true | \nReturns all users who are inactive. | \n
Example:
\n{{base_url}}/v1/account/users??include=currentuser&page=1&pagesize=10&q=doe&sortby=username
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Users in the feed altogether. | \n
| array user Items | \nContains an array of Users | \n
| string Previous | \nThe link to the previous page of Users in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Users in the feed. Null on the last page. | \n
Calling this endpoint allows you to change some properties for a specified user.
\nThe request body contains a User model describing the new values to be updated. Only properties you include will be updated; all others will stay the same.
\nThe response body contains the User model with the updated properties.
\n","urlObject":{"path":["v1","account","users","{{user_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2956d635-ceb6-4b91-937d-27a72ffd3f5d","name":"Modify User Permissions","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"Permissions\": {\r\n \"CanSeeAllBroadcasts\": false,\r\n \"CanSeeAllRoster\": false,\r\n \"CanSeeAllAudio\": false,\r\n \"CanSeeGroupAudio\": false\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:59:54 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"},{"id":"47f3fb38-b5c3-46c7-b63e-2a9010294179","name":"Modify User's Name","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Doe\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:52:47 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"},{"id":"7545cea2-a4fc-42e2-870e-3414862bbf1b","name":"Modify Calling Window","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"CallingWindowDays\": [ \"Monday\", \"Wednesday\", \"Friday\" ],\r\n \"StartTimeOfDay\": {\r\n \"Hour\": 8,\r\n \"Minute\": 30\r\n },\r\n \"StopTimeOfDay\": {\r\n \"Hour\": 21,\r\n \"Minute\": 0\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:55:40 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"},{"id":"c32b0809-6562-4d9f-9947-72927dcd7d76","name":"Modify Voice Settings","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"CallerIDNumber\": \"2149221200\",\r\n \"DefaultRetryTimes\": 2,\r\n \"DefaultMaxMessageLength\": 90,\r\n \"CallThrottle\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:58:37 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"}],"_postman_id":"fe575afc-0449-41f5-8ee3-8802961263a3"},{"name":"Add new Account User","id":"7d5d67d1-c7b1-4272-934c-b78c5ef704d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"Using this endpoint, an account owner can add a new user to the account.
\nPlease see the examples for the required and optional input properties.
\nTo determine the user's time zone, either the State or the combination of TimeZoneOffset and ObservesDaylightSavings needs to be provided.
\nUsername and PinCode (password) is not required, If omitted, a random username and password is generated.
\nThe user's authorization token is returned only once on creation. Store the token or use the POST /v1/user/login endpoint to obtain it again.
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
string FirstName | The user's first name. [50 Characters Max] |
string LastName | The user's last name. [50 Characters Max] |
email Email | The user's email address. |
phone-number Phone | The user's phone number. |
string State | The 2 character abbreviation for the US state which matches the user's time zone [Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified] |
integer TimeZoneOffset | The number of hours difference (plus or minus) between the user's time zone and Central Standard Time. [Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified] |
boolean ObservesDaylightSavings | Whether the user's time zone observes daylight savings time. [Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified] |
boolean IsAccountAdmin | If set to true, the user will have administrator permissions on the account. [Optional, defaults to false.] |
phone-number CallerIDNumber | The phone number to be displayed on a recipient's caller ID. [Optional: If omitted the number in the Phone input property is used.] |
array of days CallingWindowDays | The list of the day's names that call broadcasts are allowed to send. [Optional: E.g. \"Monday\", \"Tuesday\". If omitted broadcasts can be sent on all days of the week.] |
integer CallThrottle | Call speed. An upper limit on the number of simultaneous calls that can be ongoing at any given time. [Optional: The default is maximum speed.] |
boolean DefaultContinueOnNextDay | If set to true, calls will resume on the next day if they do not complete within the calling window of the scheduled broadcast date. [Optional: The default value is false.] |
integer DefaultMaxMessageLength | The time limit, in seconds, for voice broadcast messages. Additional credits are charged for each 30 seconds added. [Optional: If omitted, the account owner's maximum message length gets set as the value.] |
integer DefaultRetryTimes | The number of times a call will be retried (if the first attempt fails) before giving up. [Optional: The default value is 1.] |
integer DefaultTextSegments | The number of text segments (160 characters per segment) for text broadcast messages. Additional credits are charged for each additional segment greater than one. [Optional: If omitted, the account owner's text segment limit gets set.] |
phone-number NotificationPhone | The phone number to receive text notifications if the user has unread inbound message replies. [Optional: If omitted the number in the Phone input property is used.] |
permissions Permissions | User permissions. [Optional: If omitted the user has only has access to his/her own audio, contacts and broadcasts.] |
password PinCode | The login password. [Optional: If omitted a random password is generated.] |
phone-number SMSLaunchPhone | A user can launch text broadcasts from their phone when initiated from the phone number in this field. [Optional: If omitted the number in the Phone input property is used.] |
time-of-day StartTimeOfDay | The earliest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 AM.] |
time-of-day StopTimeOfDay | The latest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 PM.] |
username Username | The login username. [Optional: If omitted a random username is generated. The user's email address is recommended as the username.] |
The response body contains the User model with the updated properties.
\n","urlObject":{"path":["v1","account","users"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0f5c480a-2c0a-4439-9fba-40ab41d40874","name":"Add new User with required fields only","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"Email\": \"random_email30294@gmail.com\",\r\n \"Phone\": \"2149221200\",\r\n \"State\": \"TX\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 05:01:52 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": \"3875015\",\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": \"f9f3951e-c292-4228-a779-f06fd53e5fa8\",\n \"State\": \"TX\",\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"},{"id":"527aede3-ab8e-41b9-bbf8-4f742e341bdf","name":"Add new User with all optional customization","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"apiDocTestUser538150\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"PinCode\": \"RandomPass892715\",\r\n \"Email\": \"random_email237590@gmail.com\",\r\n \"Phone\": \"2149221200\",\r\n \"CallerIDNumber\": \"2149221200\",\r\n \"TimeZoneOffset\": 6,\r\n \"ObservesDaylightSavings\": true,\r\n \"DefaultRetryTimes\": 1,\r\n \"DefaultMaxMessageLength\": 120,\r\n \"CallThrottle\": 250,\r\n \"DefaultContinueOnNextDay\": false,\r\n \"SMSLaunchPhone\": \"2149221200\",\r\n \"NotificationPhone\": \"2149221200\",\r\n \"CallingWindowDays\": [ \"Saturday\", \"Sunday\" ],\r\n \"DefaultSettingCharacterCount\": 160,\r\n \"DefaultTextSegments\": 2,\r\n \"StartTimeOfDay\": {\r\n \"Hour\": 9,\r\n \"Minute\": 30\r\n },\r\n \"StopTimeOfDay\": {\r\n \"Hour\": 20,\r\n \"Minute\": 0\r\n },\r\n \"Permissions\": {\r\n \"CanSeeAllBroadcasts\": true,\r\n \"CanSeeAllRoster\": true,\r\n \"CanSeeAllAudio\": true,\r\n \"CanSeeGroupAudio\": true\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 05:00:39 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": \"RandomPass161230\",\n \"UserID\": 214803,\n \"UserName\": \"apiDocTestUser265871\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email675648@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsMasterUser\": false,\n \"IsAccountAdmin\": false,\n \"AuthToken\": \"9df11dc6-6096-4eac-99d9-3c7f87d692c8\",\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": true\n }\n}"}],"_postman_id":"7d5d67d1-c7b1-4272-934c-b78c5ef704d3"}],"id":"a9af1812-6fcc-40ca-b1e9-3658fcd4b290","description":"The endpoints in this section will return information about your high level account and individual user(s).
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c250986a-a87c-4495-bd87-efdc13f6472c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6f76f4a5-85e9-47b4-b4a1-643c27ddc4b9","type":"text/javascript","exec":[""]}}],"_postman_id":"a9af1812-6fcc-40ca-b1e9-3658fcd4b290"},{"name":"Audio","item":[{"name":"Get All Audio","id":"f32ee3df-0f95-427b-866f-9a354720d672","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"This endpoint will return an array of all Audio. Sub-users will only see their audio unless the account owner shares audio with them.
\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=tts | Search your audio with this search string. [Searches the name, description and audioID with your search string]. |
sortby | sortby=lastused | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-startdate] |
isfavorite | isfavorite=true | If true, will return all audio marked as a favorite. Otherwise, will return all audio not marked as favorite. |
isshared | isshared=false | If true, will return all audio shared with sub-users. Otherwise, will return all audio not shared with sub-users. |
unused | unused=true | If true, will return all audio never used on a broadcast. Otherwise, will return all audio previously used on a broadcast. |
broadcasttype | broadcasttype=announcement | Will filter results based on any voice broadcast type. [Can be one of: announcement, survey or transferandconnect] |
messagetype | messagetype=liveanswer | Will filter results based on the message type. [Can be one of: liveanswer or voicemail] |
Example:
\n\n{{base_url}}/v1/audio?page=1&pagesize=10&takesize=10&sortby=lastused
The response body contains the following properties:
\n\n| Property | Description |
|---|---|
integer Size | The total number of audio in the feed altogether. |
array audio Items | Contains an array of audio |
string Previous | The link to the previous page of audio in the feed. Null on the first page. |
string Next | The link to the next page of audio in the feed. Null on the last page. |
The Response contains an audio model.
","urlObject":{"path":["v1","audio","{{audio_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a5670745-6a6f-4659-8fd5-829656d8cb9b","name":"Get Audio by ID Response","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{base_url}}/v1/audio/{{audio_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 27 May 2021 22:15:11 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/audio/ah2460\",\n \"AudioID\": \"ah2460\",\n \"Name\": \"TTS Audio\",\n \"Description\": \"Available to work now\",\n \"Favorite\": true,\n \"Shared\": true,\n \"Length\": 13,\n \"MessageType\": \"Announcement Voice Mail\",\n \"ReadOnly\": false,\n \"Created\": \"2020-11-20 16:17:04-0600\",\n \"LastUsed\": \"2020-11-20 16:19:41-0600\",\n \"TextToSpeech\": true\n}"}],"_postman_id":"5976156e-2d34-433e-8389-a0083b31627c"},{"name":"Add Audio to Library from Upload","id":"c0e8afda-c06a-46c9-b804-ddeda1431421","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"content-type":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"This endpoint allows you to upload audio to your Text-Em-All Audio Library.
\n\nYou can upload a MP3 or WAV file that is between 10 seconds and 120 seconds in length.
\n\n\nThe response will be an audio model of the newly created audio.
\n","urlObject":{"path":["v1","audio","my_audio.mp3"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0ec22329-d46b-4e01-9a60-3ace75f1e19b","name":"Upload Audio Response","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"audio/mpeg"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","src":"///Mac/Home/Downloads/my_audio.mp3"}]},"url":"{{base_url}}/v1/audio/my_audio.mp3"},"status":"Partial Content","code":206,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"public, max-age=0"},{"key":"Content-Length","value":"272"},{"key":"Content-Type","value":"application/json"},{"key":"Accept-Ranges","value":"bytes"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 01 Jun 2021 19:17:59 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/audio/as0958\",\n \"AudioID\": \"as0958\",\n \"Name\": \"my_audio.mp3\",\n \"Description\": null,\n \"Favorite\": false,\n \"Shared\": null,\n \"Length\": 13,\n \"MessageType\": \"Never Used\",\n \"ReadOnly\": false,\n \"Created\": \"2021-06-01 14:18:00-0500\",\n \"LastUsed\": null,\n \"TextToSpeech\": false,\n \"Text\": null,\n \"Voice\": null\n}"}],"_postman_id":"c0e8afda-c06a-46c9-b804-ddeda1431421"},{"name":"Update Audio Details","id":"6949da8d-ba09-4887-a1a6-86aefe698a25","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"This request body contains an audio model describing the new values to be updated. Only properties you include will be updated; all others will stay the same.
\nThe response body contains the audio model with the updated properties.
\n","urlObject":{"path":["v1","audio","{{audio_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e6ae2a42-e06d-4087-8943-35ffdb82d0d4","name":"Update Audio Response","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"TTS Audio\",\r\n \"Description\": \"Available to work now\",\r\n \"Favorite\": true,\r\n \"Shared\": true\r\n}"},"url":"{{base_url}}/v1/audio/{{audio_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 01 Jun 2021 19:32:13 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/audio/ah2460\",\n \"AudioID\": \"ah2460\",\n \"Name\": \"TTS Audio\",\n \"Description\": \"Available to work now\",\n \"Favorite\": true,\n \"Shared\": true,\n \"Length\": 13,\n \"MessageType\": \"Announcement Voice Mail\",\n \"ReadOnly\": false,\n \"Created\": \"2020-11-20 16:17:04-0600\",\n \"LastUsed\": \"2020-11-20 16:19:41-0600\",\n \"TextToSpeech\": true\n}"}],"_postman_id":"6949da8d-ba09-4887-a1a6-86aefe698a25"},{"name":"Remove Audio","id":"2c222c77-9517-4cd5-b268-73bb902291d8","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"This endpoint allows you to delete a single audio from your Audio Library.
\nThe response is a HTTP Response Status Code
\n","urlObject":{"path":["v1","audio","{{audio_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"002357fd-446c-4689-b973-8f1d69ea4fb0","name":"Remove Audio Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{base_url}}/v1/audio/{{audio_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 01 Jun 2021 19:42:36 GMT"},{"key":"Content-Length","value":"0"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2c222c77-9517-4cd5-b268-73bb902291d8"}],"id":"fd36061a-e95d-451b-9093-e181724ea561","_postman_id":"fd36061a-e95d-451b-9093-e181724ea561","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return an array of all broadcasts, regardless of the broadcast status. Sub-users will only receive all broadcasts if their user permissions allow them to see all broadcasts; otherwise, sub-users will only see broadcasts they created.
\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=employees | Search your broadcasts with this search string. [Searches the broadcastID and the broadcast name with your search string]. |
sortby | sortby=startdate | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-startdate] |
startdate-from | startdate-from=2021-05-11 | Get all broadcasts where the broadcast start date is after the value of this field. |
startdate-to | startdate-to=2021-05-19 | Get all broadcasts where the broadcast start date is before the value of this field. |
createdate-from | createdate-from=2021-05-11 | Get all broadcasts where the broadcast create date is after the value of this field. |
createdate-to | createdate-to=2021-05-19 | Get all broadcasts where the broadcast create date is before the value of this field. |
broadcasttype | broadcasttype=announcement | Search for broadcasts by their type |
broadcaststatus | broadcaststatus=completed | Search for broadcasts by their status |
hasreplies | hasreplies=false | If this value is set to true, text broadcasts with replies will be returned. If the value is set to false, any broadcast with no replies will be returned. |
hasunreadreplies | hasunreadreplies=true | If this value is set to true, text broadcasts with unread replies will be returned. If the value is set to false, only broadcasts with no unread replies will be returned. |
Example:
\n\n{{base_url}}/v1/broadcasts?page=1&pagesize=10&takesize=10&sortby=startdate
The response body contains the following properties:
\n\n| Property | Description |
|---|---|
integer Size | The total number of Broadcasts in the feed altogether. |
array broadcast Items | Contains an array of Broadcasts |
string Previous | The link to the previous page of Broadcasts in the feed. Null on the first page. |
string Next | The link to the next page of Broadcasts in the feed. Null on the last page. |
This endpoint will allow you to create a new broadcast. Please see the examples for the required and optional input properties.
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
string BroadcastName | The name of the broadcast. [Required] |
broadcast-type BroadcastType | The type of the broadcast. [Required] |
date-time StartDate | The time the broadcast should start. [Optional: Will default to start immediately.] |
phone-number CallerID | Voice messages will appear to be coming from this phone number. [Optional: If left blank, we will default to the callerID in your voice settings.] |
transfer-and-connect TransferAndConnect | The settings for transfer & connect broadcasts. [Optional: Only required for Transfer & Connect type broadcasts.] |
audio Audio | The assigned audio message for voice broadcasts. This ID can be found in your Message Library. [Optional: If left blank you will receive a message recording information in your response.] |
audio AudioVM | This message plays if the contact's message is left on the recipient's voicemail. Since they can't press a numerical response, you can leave a more general message. This ID can be found in your Message Library. [Optional: Only required for Survey or Transfer & Connect type broadcats. If left blank you will receive a message recording information in your response.] |
integer RetryTimes | The number of times a call is retried after busy signal or no answer. [Optional: Defaults to retry settings in your account.] |
integer CallThrottle | The call speed specifies the number of simultaneous calls that can be ongoing at any given time. [Optional: If not set, we will default to the call speed setting in your account.] |
integer MaxMessageLength | The maximum number of seconds the audio message can be. [Optional: If not set, the value from your voice settings.] |
string TextMessage | The text of the message for a text type broadcast. The max length is based on the setting in your account. [Required for any text type broadcast.] |
integer TextNumberID | The ID of the text number your messages will be sent from. [Optional: If omitted, the default text number on your account will be used. You can view a available text number by calling GET/textnumbers] |
boolean CheckCallingWindow | Used for voice messages only and determines whether to enforce or ignore the user's calling window. [Optional: Defaults to True.] |
boolean ContinueOnNextDay | Can override the \"continue on next day\" user setting. [Optional: If omitted, the user's setting will be used.] |
boolean PrimaryPhoneNumbersOnly | Whether to use the contact's primary phones only when creating the broadcast. [Optional: Defaults to false.] |
integer DraftBroadcastID | Create the broadcast using this draft broadcast previously assembled. [Optional: Can only be used if you first posted to the drat broadcast endpoint, POST/draftbroadcasts.] |
array List Lists | Include all contacts from one or many of your Contact Groups. For each group you wish to include, add an object with a ListID property and value of the ID for list. [Optional: Only required if you have not included any FileUploads or Contacts.] |
array contact Contacts | All contacts listed here will be included in your broadcast. A PrimaryPhone is required for each contact included; the rest of the contact properties are optional.[Optional: Only required if you have not included any Lists or FileUploads.] |
array contact ExcludedContacts | All contacts listed here will be excluded from your broadcast. [A PrimaryPhone is required for each contact excluded; the rest of the contact properties are optional.] |
array file-upload FileUploads | Include all contacts from the File Uploads listed to the broadcast.[Optional: Only required if you have not included any Lists or Contacts.] |
The response body contains the Broadcast model with the updated properties.
\n","urlObject":{"path":["v1","broadcasts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"482becac-6756-445f-a473-b14ed35e10d4","name":"Transfer & Connect set to start immediately using Text-To-Speech as the audio","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BroadcastName\": \"Testing Alert System with Transfer Option\",\r\n \"BroadcastType\": \"Announcement\",\r\n \"StartDate\": \"\",\r\n \"CheckCallingWindow\": false,\r\n \"TextMessage\": \"This is a test text message. Please reply.\",\r\n \"TransferAndConnect\": {\r\n \"IsTransfer\": true,\r\n \"TransferLines\": 1,\r\n \"TransferNumber\": \"2142960678\"\r\n },\r\n \"Contacts\": \r\n [\r\n {\r\n \"FirstName\": \"Jack\",\r\n \"LastName\": \"Black\",\r\n \"PrimaryPhone\": \"5052053399\",\r\n \"Notes\": \"ID 123456\",\r\n \"IntegrationData\": \"A67CH829\"\r\n }\r\n ],\r\n \"Audio\": {\r\n \"TextToSpeech\": true,\r\n \"Text\": \"This audio will play if the person answers live. We have immediate openings for the evening shift. If you are available to work, please press 0 to be transferred to the scheduling team.\"\r\n },\r\n \"AudioVM\": {\r\n \"TextToSpeech\": true,\r\n \"Text\": \"This audio will play if the person does not answer and the call goes to voicemail. We have immediate openings for the evening shift. If you are available to work, please call us back at 214-296-0678.\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/broadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 20 Nov 2020 20:04:08 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10006607\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10006607/details\",\n \"BroadcastID\": 10006607,\n \"BroadcastName\": \"Testing Alert System with Transfer Option\",\n \"BroadcastType\": \"Announcement\",\n \"BroadcastStatus\": \"AuthorizationApproved\",\n \"BroadcastStatusCategory\": \"Scheduled\",\n \"CreatedDate\": \"2020-11-20 14:04:09-0600\",\n \"StartDate\": \"2020-11-20 14:04:08-0600\",\n \"CompletedDate\": null,\n \"CallerID\": \"2142960678\",\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 1,\n \"PhoneNumberCount\": 1,\n \"TotalCompleted\": 0,\n \"User\": {\n \"PinCode\": null,\n \"UserID\": 215790,\n \"UserName\": null,\n \"FirstName\": null,\n \"LastName\": null,\n \"Email\": null,\n \"Phone\": null,\n \"CallerID\": null,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": null\n },\n \"TransferAndConnect\": {\n \"IsTransfer\": true,\n \"TransferLines\": 1,\n \"TransferNumber\": \"2142960678\",\n \"TransferCreditsUsed\": null\n },\n \"Audio\": {\n \"Uri\": \"/v1/audio/ah2441\",\n \"AudioID\": \"ah2441\",\n \"Name\": null,\n \"Description\": null,\n \"Favorite\": null,\n \"Shared\": null,\n \"Length\": 10,\n \"MessageType\": null,\n \"ReadOnly\": null,\n \"Created\": null,\n \"LastUsed\": null,\n \"TextToSpeech\": false\n },\n \"AudioVM\": {\n \"Uri\": \"/v1/audio/ah2442\",\n \"AudioID\": \"ah2442\",\n \"Name\": null,\n \"Description\": null,\n \"Favorite\": null,\n \"Shared\": null,\n \"Length\": 13,\n \"MessageType\": null,\n \"ReadOnly\": null,\n \"Created\": null,\n \"LastUsed\": null,\n \"TextToSpeech\": false\n },\n \"RetryTimes\": 1,\n \"CallThrottle\": 0,\n \"LivePersonTotal\": 0,\n \"AnsweringMachineTotal\": 0,\n \"BusyNoAnswerTotal\": 0,\n \"InvalidNumberTotal\": 0,\n \"SurveyResponseTotal\": 0,\n \"TransferTotal\": 0,\n \"SurveyResponses\": null,\n \"MaxMessageLength\": 30,\n \"MessageRecordingInstruction\": null,\n \"EstimatedDuration\": 0,\n \"EstimatedCompletion\": null,\n \"ExcludedDaysIgnored\": false,\n \"CallingWindowIgnored\": false,\n \"NotEnoughTimeToComplete\": false\n}"},{"id":"cc1181b1-61ab-4cf5-9328-1602c450c694","name":"Announcement created from contact group and audio from library, scheduled to start in the future","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BroadcastName\": \"Testing Alert System 10/27/2020\",\r\n \"BroadcastType\": \"Announcement\",\r\n \"StartDate\": \"11/27/2020 5:15PM\",\r\n \"CheckCallingWindow\": false,\r\n \"TextMessage\": \"This is a test text message. Please reply.\",\r\n \"Lists\": \r\n [\r\n {\r\n \"ListID\": 1\r\n }\r\n ],\r\n \"Audio\": \r\n {\r\n \"AudioID\": \"ah2439\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/broadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 20 Nov 2020 19:29:43 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10006604\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10006604/details\",\n \"BroadcastID\": 10006604,\n \"BroadcastName\": \"Testing Alert System 10/27/2020\",\n \"BroadcastType\": \"Announcement\",\n \"BroadcastStatus\": \"AuthorizationApproved\",\n \"BroadcastStatusCategory\": \"Scheduled\",\n \"CreatedDate\": \"2020-11-20 13:29:43-0600\",\n \"StartDate\": \"2020-11-27 17:15:00-0600\",\n \"CompletedDate\": null,\n \"CallerID\": \"2142960678\",\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 1,\n \"PhoneNumberCount\": 1,\n \"TotalCompleted\": 0,\n \"User\": {\n \"PinCode\": null,\n \"UserID\": 215790,\n \"UserName\": null,\n \"FirstName\": null,\n \"LastName\": null,\n \"Email\": null,\n \"Phone\": null,\n \"CallerID\": null,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": null\n },\n \"TransferAndConnect\": null,\n \"Audio\": {\n \"Uri\": \"/v1/audio/ah2439\",\n \"AudioID\": \"ah2439\",\n \"Name\": null,\n \"Description\": null,\n \"Favorite\": null,\n \"Shared\": null,\n \"Length\": 14,\n \"MessageType\": null,\n \"ReadOnly\": null,\n \"Created\": null,\n \"LastUsed\": null,\n \"TextToSpeech\": false\n },\n \"AudioVM\": null,\n \"RetryTimes\": 1,\n \"CallThrottle\": 0,\n \"LivePersonTotal\": 0,\n \"AnsweringMachineTotal\": 0,\n \"BusyNoAnswerTotal\": 0,\n \"InvalidNumberTotal\": 0,\n \"SurveyResponseTotal\": 0,\n \"TransferTotal\": 0,\n \"SurveyResponses\": null,\n \"MaxMessageLength\": 30,\n \"MessageRecordingInstruction\": null,\n \"EstimatedDuration\": 0,\n \"EstimatedCompletion\": null,\n \"ExcludedDaysIgnored\": false,\n \"CallingWindowIgnored\": false,\n \"NotEnoughTimeToComplete\": false\n}"},{"id":"e34c12b9-5f8d-46f0-9fc5-607ccf556a1c","name":"Create Text Broadcast from Numbers Listed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BroadcastName\": \"A Test Text Broadcast\",\r\n \"BroadcastType\": \"SMS\",\r\n \"StartDate\": \"\",\r\n \"CheckCallingWindow\": false,\r\n \"TextMessage\": \"This is a test text message. Please reply.\",\r\n \"TextNumberID\": 99347,\r\n \"Contacts\": \r\n [\r\n {\r\n \"FirstName\": \"Jack\",\r\n \"LastName\": \"Black\",\r\n \"PrimaryPhone\": \"2142998560\",\r\n \"Notes\": \"ID 123456\",\r\n \"IntegrationData\": \"A67CH829\"\r\n },\r\n {\r\n \"FirstName\": \"Susan\",\r\n \"LastName\": \"White\",\r\n \"PrimaryPhone\": \"4678621345\",\r\n \"Notes\": \"ID 234567\",\r\n \"IntegrationData\": \"B57CH189\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/broadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Thu, 12 Jan 2023 20:26:52 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10020847\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10020847/details\",\n \"BroadcastID\": 10020847,\n \"BroadcastName\": \"A Test Text Broadcast\",\n \"BroadcastType\": \"SMS\",\n \"BroadcastStatus\": \"MessageRecorded\",\n \"BroadcastStatusCategory\": \"Processing\",\n \"CreatedDate\": \"2023-01-12 15:26:52-0500\",\n \"StartDate\": \"2023-01-12 15:26:52-0500\",\n \"CompletedDate\": null,\n \"CallerID\": null,\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 1,\n \"PhoneNumberCount\": 1,\n \"TotalCompleted\": 0,\n \"IsTextSurvey\": null,\n \"User\": {\n \"PinCode\": null,\n \"UserID\": 73312,\n \"UserName\": null,\n \"FirstName\": null,\n \"LastName\": null,\n \"Email\": null,\n \"Phone\": null,\n \"CallerID\": null,\n \"IsMasterUser\": null,\n \"IsAccountAdmin\": null,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": null,\n \"Signature\": null,\n \"ProfilePictureURI\": null\n },\n \"Labels\": null,\n \"TransferAndConnect\": null,\n \"TextSurveyResponseTotal\": 0,\n \"TextSurveyResponses\": null,\n \"AddOns\": null,\n \"TextMessage\": \"This is a test text message. Please reply.\",\n \"DeliveredTexts\": 0,\n \"NotDeliveredTexts\": 1,\n \"InvalidTextCount\": 0,\n \"FailedTextTotal\": 0,\n \"TextReplies\": 0,\n \"RepliedTotal\": 0,\n \"UnreadTextReplies\": 0,\n \"UnreadConversationReplies\": 0,\n \"NotRepliedTotal\": 0,\n \"TextOptedOut\": 0,\n \"TextNumberID\": 99347,\n \"TextPhoneNumber\": \"14690764256\",\n \"HasMedia\": false,\n \"TextBroadcastID\": 0\n}"},{"id":"c1fc1e6f-2d60-429a-b997-55a3190a5429","name":"Create Text Broadcast from File Upload","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"BroadcastName\": \"Test Text Broadcast from File Upload\",\r\n \"BroadcastType\": \"SMS\",\r\n \"StartDate\": \"\",\r\n \"CheckCallingWindow\": false,\r\n \"TextMessage\": \"This is a test text message. Please reply.\",\r\n \"TextNumberID\": 99347,\r\n \"FileUploads\": \r\n [\r\n {\r\n \"FileID\": \"73312_20230112143200.csv\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/broadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Thu, 12 Jan 2023 20:35:40 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10020848\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10020848/details\",\n \"BroadcastID\": 10020848,\n \"BroadcastName\": \"Test Text Broadcast from File Upload\",\n \"BroadcastType\": \"SMS\",\n \"BroadcastStatus\": \"MessageRecorded\",\n \"BroadcastStatusCategory\": \"Processing\",\n \"CreatedDate\": \"2023-01-12 15:35:41-0500\",\n \"StartDate\": \"2023-01-12 15:35:41-0500\",\n \"CompletedDate\": null,\n \"CallerID\": null,\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 1,\n \"PhoneNumberCount\": 1,\n \"TotalCompleted\": 0,\n \"IsTextSurvey\": null,\n \"User\": {\n \"PinCode\": null,\n \"UserID\": 73312,\n \"UserName\": null,\n \"FirstName\": null,\n \"LastName\": null,\n \"Email\": null,\n \"Phone\": null,\n \"CallerID\": null,\n \"IsMasterUser\": null,\n \"IsAccountAdmin\": null,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": null,\n \"Signature\": null,\n \"ProfilePictureURI\": null\n },\n \"Labels\": null,\n \"TransferAndConnect\": null,\n \"TextSurveyResponseTotal\": 0,\n \"TextSurveyResponses\": null,\n \"AddOns\": null,\n \"TextMessage\": \"This is a test text message. Please reply.\",\n \"DeliveredTexts\": 0,\n \"NotDeliveredTexts\": 1,\n \"InvalidTextCount\": 0,\n \"FailedTextTotal\": 0,\n \"TextReplies\": 0,\n \"RepliedTotal\": 0,\n \"UnreadTextReplies\": 0,\n \"UnreadConversationReplies\": 0,\n \"NotRepliedTotal\": 0,\n \"TextOptedOut\": 0,\n \"TextNumberID\": 99347,\n \"TextPhoneNumber\": \"14690764256\",\n \"HasMedia\": false,\n \"TextBroadcastID\": 0\n}"}],"_postman_id":"8727a741-9943-4f04-a26c-ac088b409233"},{"name":"View Single Broadcast","id":"502e9dcc-8d1b-4be9-84a3-81bb60f3567f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return a single broadcast model with the broadcast the matching BroadcastID passed in the URL. Sub-users will only receive the broadcast if their user permissions allow them to see all broadcasts or if the broadcast was created by the user who requested it.
\n","urlObject":{"path":["v1","broadcasts","{{BroadcastID}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"2ad0049e-264a-4185-a014-792aa00b0618","name":"Get Single Text Broadcast","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/broadcasts/{{BroadcastID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1149"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcYnJvYWRjYXN0c1wxMDAwNjI2MA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 27 Oct 2020 22:03:17 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10006260\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10006260/details\",\n \"BroadcastID\": 10006260,\n \"BroadcastName\": \"Testing Alert System 10/27/2020\",\n \"BroadcastType\": \"SMS\",\n \"BroadcastStatus\": \"AwaitingAuthorization\",\n \"BroadcastStatusCategory\": \"Processing\",\n \"CreatedDate\": \"2020-10-27 15:55:22-0500\",\n \"StartDate\": \"2020-10-27 17:15:00-0500\",\n \"CompletedDate\": null,\n \"CallerID\": null,\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 2,\n \"PhoneNumberCount\": 2,\n \"TotalCompleted\": 0,\n \"User\": {\n \"UserID\": 215790,\n \"UserName\": \"test-payg-user@gmail.com\",\n \"FirstName\": \"API\",\n \"LastName\": \"User\",\n \"Email\": \"test-payg-user@gmail.com\",\n \"Phone\": \"2142960678\",\n \"CallerID\": \"2142960678\",\n \"IsMasterUser\": true,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": false\n }\n },\n \"TransferAndConnect\": null,\n \"TextMessage\": \"This is a test text message. Please reply.\",\n \"DeliveredTexts\": 0,\n \"NotDeliveredTexts\": 2,\n \"InvalidTextCount\": 0,\n \"FailedTextTotal\": 0,\n \"TextReplies\": 0,\n \"UnreadTextReplies\": 0,\n \"UnreadConversationReplies\": 0,\n \"NotRepliedTotal\": 0,\n \"TextOptedOut\": 0,\n \"TextNumberID\": 98912,\n \"TextPhoneNumber\": \"18334063202\",\n \"TextBroadcastID\": 0\n}"},{"id":"822b5783-59c2-48ed-88f5-4c414efd132d","name":"Get Single Voice Broadcast","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/broadcasts/{{BroadcastID}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1513"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcYnJvYWRjYXN0c1wxMDAwNjI1OQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 27 Oct 2020 22:05:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/broadcasts/10006259\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10006259/details\",\n \"BroadcastID\": 10006259,\n \"BroadcastName\": \"Testing Alert System 10/27/2020\",\n \"BroadcastType\": \"Announcement\",\n \"BroadcastStatus\": \"AwaitingAuthorization\",\n \"BroadcastStatusCategory\": \"Processing\",\n \"CreatedDate\": \"2020-10-27 15:55:22-0500\",\n \"StartDate\": \"2020-10-27 17:15:00-0500\",\n \"CompletedDate\": null,\n \"CallerID\": \"2142960678\",\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 2,\n \"PhoneNumberCount\": 2,\n \"TotalCompleted\": 0,\n \"User\": {\n \"UserID\": 215790,\n \"UserName\": \"test-payg-user@gmail.com\",\n \"FirstName\": \"API\",\n \"LastName\": \"User\",\n \"Email\": \"test-payg-user@gmail.com\",\n \"Phone\": \"2142960678\",\n \"CallerID\": \"2142960678\",\n \"IsMasterUser\": true,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": false\n }\n },\n \"TransferAndConnect\": null,\n \"Audio\": {\n \"Uri\": \"/v1/audio/ah2439\",\n \"AudioID\": \"ah2439\",\n \"Name\": null,\n \"Description\": null,\n \"Favorite\": false,\n \"Shared\": null,\n \"Length\": 14,\n \"MessageType\": \"Never Used\",\n \"ReadOnly\": false,\n \"Created\": \"2020-10-22 09:38:13-0500\",\n \"LastUsed\": \"2020-10-27 17:15:00-0500\",\n \"TextToSpeech\": false\n },\n \"AudioVM\": null,\n \"RetryTimes\": 1,\n \"CallThrottle\": 0,\n \"LivePersonTotal\": 0,\n \"AnsweringMachineTotal\": 0,\n \"BusyNoAnswerTotal\": 0,\n \"InvalidNumberTotal\": 0,\n \"SurveyResponseTotal\": 0,\n \"TransferTotal\": 0,\n \"SurveyResponses\": null,\n \"MaxMessageLength\": 30,\n \"MessageRecordingInstruction\": null,\n \"EstimatedDuration\": 0,\n \"EstimatedCompletion\": null,\n \"ExcludedDaysIgnored\": false,\n \"CallingWindowIgnored\": false,\n \"NotEnoughTimeToComplete\": false\n}"}],"_postman_id":"502e9dcc-8d1b-4be9-84a3-81bb60f3567f"},{"name":"View Details of Broadcast","id":"1565c7e9-715b-439e-b485-32f7040e420d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This will allow you to view the details of a broadcast scheduled, currently going out, or completed. If the broadcast is not yet in a completed or rejected status, the results are not yet final.
\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=bob | Search your broadcasts with this search string. [Searches the first name, last name, notes and phone number with your search string]. |
sortby | sortby=callresult | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-callresult] |
callresult | callresult=LivePerson | Filter voice broadcast recipients by their call result. [In the following format: LivePerson, VoiceMail, NotCompleted, NoResult, BusyNa, or Invalid] |
callstatus | callstatus=Completed | Filter voice broadcast recipients by their call status. [In the following format: NotCalled or Completed] |
textresult | textresult=NeedsSending | Filter text broadcast recipients by their text result. [In the following format: NeedsSending, SentToAggregator, RejectedByAggregator, UnsentBecauseBcCanceled, UnsentBecauseOptedOut, UnsentBecauseBlacklisted, FailedAndResent, UnsentBecauseBcRejected or UnsentBecauseAttemptsExceeded] |
textresultcategory | textresultcategory=Delivered | Filter text broadcast recipients by their text result category. [In the following format: NotSent, Sent, Invalid, OptedOut, Delivered, or Failed] |
phonenumber | phonenumber=2142960678 | Search results for a single 10 digit phone number. |
firstname | firstname=bob | Filters result's FirstName field that match your query string. |
lastname | lastname=smith | Filters result's LastName field that match your query string. |
notes | notes=manager | Filters result's Notes field that match your query string. |
surveyresult | surveyresult=1 | If the voice broadcast was a survey type, you can filter the results by the recipients responses. [Can be any number 0-9] |
hassurveyresult | hassurveyresult=true | When true, if the voice broadcast was a survey type, you can filter all recipients who responded to the survey. If false, returns all the recipients who did NOT respond to the survey. |
istransfer | istransfer=true | When true, if the voice broadcast was a live-transfer type, you can filter all recipients who transferred. If false, returns all the recipients who did NOT transfer. |
hasreplies | hasreplies=true | When true, results will be filtered by recipients who replied to a text type broadcast. If false, only recipients who did NOT reply will be returned. |
Example:
\n\n{{base_url}}/v1/broadcasts/{{BroadcastID}}/details?page=1&takesize=10
| Property | Description |
|---|---|
integer Size | The total number of Broadcast Details in the feed altogether. |
array broadcast-detail Items | One page of Broadcast Details in the feed. |
string Previous | The link to the previous page of Broadcast Details in the feed. Null on the first page. |
string Next | The link to the next page of Broadcast Details in the feed. Null on the last page. |
The API request will return information on the status and result of a text broadcast's individual messages. If the broadcast is not yet in a completed or rejected status, the results are not yet final.
\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=bob | Search your broadcasts with this search string. [Searches the first name, last name, notes and phone number with your search string]. |
sortby | sortby=textmessageid | Currently the result can only be ordered by the text messages unique identifiers. [Include a minus in front of the value to sort in descending order. ex: sortby=-textmessageid] |
include | include=text-delivery-receipts | Optional parameter to request text delivery receipt information to be included in the response. |
isinbound | isinbound=false | Optional parameter to filter for broadcast outbound messages or inbound text replies. |
Example:
\n\nhttps://rest.call-em-all.com/v1/broadcasts/{{BroadcastID}}/text-messages?include=text-delivery-receipts&isinbound=false&page=1&pagesize=25
| Property | Description |
|---|---|
| integer Size | The total number of Text Messages in the feed altogether. |
| array text-message Items | One page of Text Messages in the feed. |
| string Previous | The link to the previous page of Text Messages in the feed. Null on the first page. |
| string Next | The link to the next page of Text Messages in the feed. Null on the last page. |
The endpoints in this section will allow you to view broadcasts, edit not completed broadcasts, and create new broadcasts.
\n","_postman_id":"a11c05be-4078-4c69-93a4-910f32b8c655","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"CAUTION: This endpoint will delete all contacts within your account!
\nTo delete an individual contact, please see the Delete a Single Contact endpoint.
\nNone
\nNo special action; simply invoke the endpoint.
\nStartFragment
\nIf the contacts were deleted, you'll receive an HTTP 200 (Success) code and no payload. If there was a problem, the response will have a non-200 code and its body will contain a JSON body with information about what was wrong (e.g., the contact doesn't exist, request couldn't be authenticated).
\nEndFragment
\n","urlObject":{"path":["v1","contacts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"11c73618-aac5-4548-a3fd-54614cdbfc2b"},{"name":"Delete a Single Contact","id":"17d3703a-9481-4d6f-875d-297e0c81c7ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Delete a single contact from your roster by passing the contact's identification number in the URL. The contact will be removed from the account's Everyone folder and all contact groups in which it was a member.
\nTo delete all contacts in the account use the Delete All Contacts endpoint.
\nNone
\nPass the contact's identification number as part of the URL.
\nIf the contact was deleted, you'll receive an HTTP 200 (Success) code and no payload. If there was a problem deleting the contact, the response will have a non-200 code and a JSON body with information about what was wrong (e.g., the contact doesn't exist, request couldn't be authenticated).
\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"17d3703a-9481-4d6f-875d-297e0c81c7ae"},{"name":"Get Contacts","id":"d2007d60-7f71-424a-a7ea-c6ac22c651b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"List or search contacts. Query parameters in the request can be used to filter and sort the result.
\n\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=doe | Search your contacts with this search string. [Searches the contact's first name, last name and notes with your search string]. |
sortby | sortby=firstnamelastname | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-firstnamelastname] |
include | include=lists | Includes a list model for any group the contact belongs to. |
voiceoptouts | voiceoptouts=true | If true, will return all contacts who are opted out of voice messages. If false, will return all contacts who are not opted out of voice messages. |
smsoptins | smsoptins=true | Returns all contacts who have texted \"Join\" to one of your text numbers. You can use this if you want to require contacts to opt in. |
smsoptouts | smsoptouts=true | Returns all contacts who are opted out of text messages. |
Example:
\n\n{{base_url}}/v1/contacts?pagesize=5&page=2&include=lists&sortby=lastnamefirstname&q=Bessie
Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.
\nThe response body contains the following properties:
\n\n| Property | Description |
|---|---|
integer Size | The total number of Contacts in the feed altogether. |
array contact Items | An array of Contacts. |
string Previous | The link to the previous page of Contacts in the feed. Null on the first page. |
string Next | The link to the next page of Contacts in the feed. Null on the last page. |
This endpoint will return a single contact based on the contact id passed in.
\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{base_url}}"],"query":[{"key":"include","value":"lists"}],"variable":[]}},"response":[{"id":"3da9b26e-f12d-44c8-b807-5dae8e0ff558","name":"Get Single Contact Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/contacts/{{contact_id}}?include=lists","host":["{{base_url}}"],"path":["v1","contacts","{{contact_id}}"],"query":[{"key":"include","value":"lists","type":"text"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1053"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udGFjdHNcNzYxMDUzOA==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 26 Feb 2021 20:35:12 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/contacts/7610538\",\n \"DoNotCallPrimaryPhone\": false,\n \"DoNotCallSecondaryPhone\": true,\n \"DoNotCallTertiaryPhone\": false,\n \"PrimaryPhoneTextOptInStatus\": \"\",\n \"SecondaryPhoneTextOptInStatus\": \"OptedOut\",\n \"TertiaryPhoneTextOptInStatus\": \"\",\n \"Lists\": [\n {\n \"Uri\": null,\n \"ListID\": 1,\n \"ListType\": \"User\",\n \"ListName\": \"Test\",\n \"ListDescription\": \"\",\n \"SMSName\": \"test\",\n \"IsAutoReplyOn\": true,\n \"AutoReplyMessage\": \"Thank you for joining!\",\n \"LastUpdated\": \"2020-10-13 16:04:35.423-0600\",\n \"RosterCount\": 1\n },\n {\n \"Uri\": null,\n \"ListID\": 2,\n \"ListType\": \"User\",\n \"ListName\": \"Employees\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:17:57.053-0600\",\n \"RosterCount\": 5\n },\n {\n \"Uri\": null,\n \"ListID\": 3,\n \"ListType\": \"User\",\n \"ListName\": \"Engineers\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:20:57.58-0600\",\n \"RosterCount\": 5\n }\n ],\n \"FirstName\": \"Bessie\",\n \"LastName\": \"James\",\n \"PrimaryPhone\": \"9725552345\",\n \"SecondaryPhone\": \"9725556590\",\n \"TertiaryPhone\": \"9725556591\",\n \"Notes\": \"\",\n \"IntegrationData\": null,\n \"PersonID\": 7610538\n}"}],"_postman_id":"424541fc-5399-41e8-9deb-b2f54cb7010f"},{"name":"Update Single Contact","id":"ec887b4b-c5c6-4893-a041-dd8851dcdcaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The request body contains a contact model describing the new values to be updated. Include all properties as you'd like them to appear on the contact; any missing properties will be updated/set as empty.
\nThe response body contains the contact model with the updated properties.
\n","urlObject":{"path":["v1","contacts","{{contact_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"7e993214-8f98-4f45-a31f-26b84d6d02fa","name":"Update Single Contact","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe2\",\r\n \"PrimaryPhone\": \"2145551332\",\r\n \"SecondaryPhone\": \"\",\r\n \"TertiaryPhone\": \"\",\r\n \"Notes\": \"Away in December!\",\r\n \"Lists\": [\r\n {\r\n \"ListID\": 1\r\n },\r\n {\r\n \"ListID\": 3\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 19:08:35 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/contacts/7610544\",\n \"Lists\": [\n {\n \"Uri\": \"/v1/lists/1\",\n \"ListID\": 1,\n \"ListType\": \"User\",\n \"ListName\": \"Test\",\n \"ListDescription\": \"\",\n \"SMSName\": \"test\",\n \"IsAutoReplyOn\": true,\n \"AutoReplyMessage\": \"Thank you for joining!\",\n \"LastUpdated\": \"2020-10-13 16:04:35.423-0500\",\n \"RosterCount\": 0\n },\n {\n \"Uri\": \"/v1/lists/3\",\n \"ListID\": 3,\n \"ListType\": \"User\",\n \"ListName\": \"Engineers\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:20:57.58-0600\",\n \"RosterCount\": 0\n }\n ],\n \"FirstName\": \"John\",\n \"LastName\": \"Doe2\",\n \"PrimaryPhone\": \"2145551332\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"Away in December!\",\n \"IntegrationData\": null,\n \"PersonID\": 7610544\n}"}],"_postman_id":"ec887b4b-c5c6-4893-a041-dd8851dcdcaa"},{"name":"Add New Contact","id":"920c2884-3088-4dce-8892-1a240328e5af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint allows you to add a new contact to your Text-Em-All roster. You can optionally add this new contact to any of your groups.
\nThe request body can contain the following properties:
\n\n| Property | Description |
|---|---|
string FirstName | The contact's first name (optional). |
string LastName | The contact's last name (optional). |
phone-number PrimaryPhone | The primary phone number (required). |
phone-number SecondaryPhone | An optional secondary phone number. |
phone-number TertiaryPhone | An optional tertiary phone number. |
string Notes | An optional note for the contact. Maximum length is 50 characters. |
array List Lists | Optionally you can add this contact to your already created groups. A list of your groups can be obtained by calling GET /lists |
The response will be a contact model of the newly created contact.
\n","urlObject":{"path":["v1","contacts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"16538eb5-0f58-4531-8477-92350605e62a","name":"Add New Contact Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe2\",\r\n \"PrimaryPhone\": \"2145551332\",\r\n \"SecondaryPhone\": \"\",\r\n \"TertiaryPhone\": \"\",\r\n \"Notes\": \"Away in December!\",\r\n \"Lists\": [\r\n {\r\n \"ListID\": 2\r\n },\r\n {\r\n \"ListID\": 3\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 26 Feb 2021 21:35:18 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/contacts/7610544\",\n \"Lists\": [\n {\n \"Uri\": \"/v1/lists/2\",\n \"ListID\": 2,\n \"ListType\": \"User\",\n \"ListName\": \"Employees\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:17:57.053-0600\",\n \"RosterCount\": 0\n },\n {\n \"Uri\": \"/v1/lists/3\",\n \"ListID\": 3,\n \"ListType\": \"User\",\n \"ListName\": \"Engineers\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:20:57.58-0600\",\n \"RosterCount\": 0\n }\n ],\n \"FirstName\": \"John\",\n \"LastName\": \"Doe2\",\n \"PrimaryPhone\": \"2145551332\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"Away in December!\",\n \"IntegrationData\": null,\n \"PersonID\": 7610544\n}"}],"_postman_id":"920c2884-3088-4dce-8892-1a240328e5af"}],"id":"0711e72c-8ea6-4354-9afc-501ade24a79a","description":"Endpoints for managing account contacts.
\n","_postman_id":"0711e72c-8ea6-4354-9afc-501ade24a79a","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return an array of conversations.
\nList or search conversations. Query parameters in the request can be used to filter and sort the result.
\n\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
textnumberid | textnumberid={{text_number_id}} | Filters conversations to/from the text number with the provided ID. |
conversationid | conversationid={{conversation_id}} | Filters conversations by the provided conversation ID. |
isdone | isdone=true | Filters conversations by the done status of the conversation. [Value can be true or false] |
isretired | isretired=false | Filters conversations by the retired status of the conversation. [Value can be true or false] |
tag | tag=auto-opt-out | Filters conversations by the tag value. [Value can be auto-opt-out] |
viewing | viewing=READ | Filters conversations by their read or unread status. [Value can be READ or UNREAD] |
broadcastid | broadcastid={{broadcast_id}} | Filters conversations by the broadcast ID. [Phone numbers that replied to a broadcast will have a conversation] |
date-from | date-from=2021-05-11 | Get all conversations where the broadcast start date is after the value of this field. |
date-to | date-to=2021-05-19 | Get all conversations where the broadcast start date is before the value of this field. |
sortby | sortby=lastmessagedate | Sort the results. [Value can be lastmessagedate, conversationid, firstnamelastname, lastnamefirstname, or phonenumber] |
This endpoint will return an array of allconversations. Sub-users will only receive all conversations if their user permissions allow them to see them; otherwise, sub-users will only see conversations they created.
","urlObject":{"path":["v1","conversations"],"host":["{{base_url}}"],"query":[{"key":"sortby","value":"-lastmessagedate"},{"key":"page","value":"1"},{"key":"pagesize","value":"10"}],"variable":[]}},"response":[{"id":"448cb1a3-aae3-4aa1-8079-b5eb20ca16ee","name":"Get All Conversations","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/conversations?sortby=-lastmessagedate&page=1&pagesize=2","host":["{{base_url}}"],"path":["v1","conversations"],"query":[{"key":"sortby","value":"-lastmessagedate"},{"key":"page","value":"1"},{"key":"pagesize","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"510"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcVXNlcnNcSmFzb25UaG9tYXNcRG9jdW1lbnRzXEdpdEh1YlxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udmVyc2F0aW9ucw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 03 Mar 2026 20:32:44 GMT"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"Size\": 263,\n \"Items\": [\n {\n \"ConversationID\": 123456,\n \"TextNumberID\": 55555,\n \"PhoneNumber\": \"9035555555\",\n \"UnreadCount\": 0,\n \"FirstName\": \"Sam\",\n \"LastName\": \"Jones\",\n \"Notes\": \"Employee\",\n \"IntegrationData\": null,\n \"OptedOut\": false,\n \"OptedIn\": true\n },\n {\n \"ConversationID\": 123457,\n \"TextNumberID\": 55555,\n \"PhoneNumber\": \"2145555555\",\n \"UnreadCount\": 6,\n \"FirstName\": \"Hai\",\n \"LastName\": \"Nguyen\",\n \"Notes\": \"Employee\",\n \"IntegrationData\": null,\n \"OptedOut\": false,\n \"OptedIn\": false\n }\n ],\n \"Previous\": null,\n \"Next\": \"/v1/conversations?sortby=-lastmessagedate&page=2&pagesize=2\"\n}"}],"_postman_id":"c1a9daa9-4425-4694-92d9-04d9bf3ef518"},{"name":"Get a Conversation","id":"1cfbae84-294b-4343-9df9-f47008b1f864","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return a conversation between one of your text numbers and a contact/recipient.
\nList or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| textphonenumber | \ntextphonenumber={{text_phone_number}} | \nThe text phone number from your Text-Em-All account. [The text number should start with a 1, making this number 11 digits] | \n
| phonenumber | \nphonenumber={{phone_number}} | \nThe 10 digit phone number of the contact or recipient. | \n
The response will return a conversation model for the requested conversation.
","urlObject":{"path":["v1","conversations","single"],"host":["{{base_url}}"],"query":[{"key":"textphonenumber","value":"{{text_phone_number}}"},{"key":"phonenumber","value":"{{phone_number}}"}],"variable":[]}},"response":[{"id":"ff0f16b1-252f-4f21-ac23-ef28d8dbb4a2","name":"Get a Conversation","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/conversations/single?textphonenumber={{text_phone_number}}&phonenumber={{phone_number}}","host":["{{base_url}}"],"path":["v1","conversations","single"],"query":[{"key":"textphonenumber","value":"{{text_phone_number}}"},{"key":"phonenumber","value":"{{phone_number}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"334"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udmVyc2F0aW9uc1xzaW5nbGU=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 21 May 2021 13:56:32 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"ConversationID\": 17262,\n \"TextNumberID\": 98912,\n \"PhoneNumber\": \"2142960678\",\n \"UnreadCount\": 0,\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Notes\": \"This note will show up in your Text-Em-All account\",\n \"IntegrationData\": \"{'OriginId':'241490','Msg':'IntegrationData will show when you GET a conversation via the API'}\",\n \"OptedOut\": false,\n \"OptedIn\": false\n}"}],"_postman_id":"1cfbae84-294b-4343-9df9-f47008b1f864"},{"name":"Get Conversation Text Thread","id":"9f60897d-9f5c-4d11-935c-adfab8a2a39a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return a text thread between one of your text numbers and a contact/recipient.
\nQuery parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| sortby | \nsortby=textmessageid | \nSort the results by the textmessageid. [Include a minus in front of the value to sort in descending order. ex: sortby=-textmessageid] | \n
| isinbound | \nisinbound=true | \nWill return all inbound messages if set to true; otherwise will return all outbound messages. | \n
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of text messages in the feed altogether. | \n
| array text-message Items | \nContains an array of text messages | \n
| string Previous | \nThe link to the previous page of text messages in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of text messages in the feed. Null on the last page. | \n
This endpoint will start a conversation between one of your text numbers and a contact/recipient. You will need to do this before you can message the contact/recipient (you will still be able to message them with a broadcast; this is only required to send individual chat messages).
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
phone-number TextPhoneNumber | This is your one of your Text-Em-All text numbers. The conversation will be between the recipient/contact and this text number. [This number should have a leading 1 making it 11 digits long] |
phone-number PhoneNumber | The phone number contacted. [This number should NOT have a leading 1 making it 10 digits long] |
string FirstName | The first name of the contact. [Maximum length is 50 characters] |
string LastName | The last name of the contact. [Maximum length is 50 characters] |
string Notes | The notes field of the contact. [Maximum length is 50 characters] |
string IntegrationData | Data field for a 3rd party integration ID. [Maximum length is 512 characters] |
text-message LastMessage | The first message to be sent to start the conversation. The Message and Contact fields required to be populated. (See example.) |
The response will return aconversation modelwith all the updated properties.
","urlObject":{"path":["v1","conversations"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"df090d66-cd07-4185-a26e-7f5d096acbd3","name":"New Conversation Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TextPhoneNumber\": {{text_phone_number}},\r\n \"PhoneNumber\": {{phone_number}},\r\n \"FirstName\": \"Frank\",\r\n \"LastName\": \"DaTank\",\r\n \"Notes\": \"This note will show up in your Text-Em-All account\",\r\n \"IntegrationData\": \"{'OriginId':'23456','Data':'This IntegrationData will show when you GET a conversation via the API'}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/conversations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"343"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udmVyc2F0aW9ucw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 21 May 2021 14:52:02 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"ConversationID\": 11459,\n \"TextNumberID\": 22222,\n \"PhoneNumber\": \"5055555555\",\n \"UnreadCount\": 0,\n \"FirstName\": \"Frank\",\n \"LastName\": \"DaTank\",\n \"Notes\": \"This note will show up in your Text-Em-All account\",\n \"IntegrationData\": \"{'OriginId':'23456','Data':'This IntegrationData will show when you GET a conversation via the API'}\",\n \"OptedOut\": false,\n \"OptedIn\": false\n}"},{"id":"5cb4aab2-7fc4-46d7-a1f7-477f4ec7afde","name":"Send a New Conversation Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TextNumberID\": 99347,\r\n \"LastMessage\": {\r\n \"Message\": \"Thank you for your application.\",\r\n \"Contact\": {\r\n \"PrimaryPhone\": \"2142998560\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/conversations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Wed, 28 Dec 2022 20:32:49 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"ConversationID\": 18145,\n \"TextNumberID\": 99347,\n \"PhoneNumber\": \"2142998560\",\n \"UnreadCount\": 0,\n \"FirstName\": null,\n \"LastName\": null,\n \"Notes\": null,\n \"IntegrationData\": null,\n \"OptedOut\": false,\n \"OptedIn\": false\n}"}],"_postman_id":"e1acc8b1-282d-41f3-94c5-022f6cb039f4"},{"name":"Send Single Chat Message","id":"de6c7491-2725-4d72-8ae0-601ee92b5c96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will allow you to send an text message to a single phone number. This endpoint is helpful if you want to customize or personalize the message like, \"Hi Jason, you have an appointment tomorrow at 9am.\"
\n| Property | \nDescription | \n
|---|---|
| Message | \nThe text message you want to send to the number. | \n
The response will return a single text message model.
","urlObject":{"path":["v1","conversations","{{conversation_id}}","textmessages"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"3591612e-419c-4bdb-ba03-bc77897f6c11","name":"Send Single Chat Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Message\": \"Hello Jason, this is Text-Em-All Staffing. Are you available for work today (5/27)?\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/conversations/{{conversation_id}}/textmessages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"355"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udmVyc2F0aW9uc1wxMTQ1OVx0ZXh0bWVzc2FnZXM=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 26 May 2021 21:10:10 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"TextMessageID\": 1223957,\n \"CreateTimestamp\": \"2021-05-26 16:10:08-0500\",\n \"IsInbound\": false,\n \"Message\": \"Hello Jason, this is Text-Em-All Staffing. Are you available for work today (5/27)?\",\n \"Type\": \"Chat\",\n \"State\": \"Sent To Aggregator\",\n \"Mms\": null,\n \"HasMedia\": false,\n \"PhoneNumber\": \"5055553399\",\n \"TextNumberID\": 222222,\n \"UriForUser\": \"/users/11111\",\n \"UriForBroadcast\": null\n}"}],"_postman_id":"de6c7491-2725-4d72-8ae0-601ee92b5c96"},{"name":"Update an Existing Conversation","id":"5cac8d0e-8868-4f9b-bb14-c727951b3566","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Calling this endpoint you can change some properties of a specific conversation.
\nThe request body contains a Conversation model describing the new values to be updated. Only properties you include will be updated; all others will stay the same.
\nThe response body contains the Conversation model with the updated properties.
\n","urlObject":{"path":["v1","conversations","{{conversation_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"da9f9a8c-6ba0-4605-871a-da129f874e2c","name":"Update Conversation Response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"Frank\",\r\n \"LastName\": \"Tanked\",\r\n \"Notes\": \"Updated Notes\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/conversations/{{conversation_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"306"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcY29udmVyc2F0aW9uc1wxMTQ1OQ==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 24 May 2021 20:19:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"ConversationID\": 11459,\n \"TextNumberID\": 98912,\n \"PhoneNumber\": \"5052053399\",\n \"UnreadCount\": 0,\n \"FirstName\": \"Frank\",\n \"LastName\": \"Tanked\",\n \"Notes\": \"Updated Notes\",\n \"IntegrationData\": \"{'OriginId':'23456','Data':'This IntegrationData will show when you GET a conversation via the API'}\",\n \"OptedOut\": false,\n \"OptedIn\": false\n}"}],"_postman_id":"5cac8d0e-8868-4f9b-bb14-c727951b3566"}],"id":"3edf6178-47cb-41b0-ac24-1d4c399e77e8","description":"Endpoints for listing, viewing, creating and managing conversations. It also includes the endpoint to send a single text message.
\n","_postman_id":"3edf6178-47cb-41b0-ac24-1d4c399e77e8","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"List or search phone numbers who have opted out of of your messages.
\n\nQuery parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| sortby | \nsortby=phonenumber | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-phonenumber] | \n
| dateadded | \ndateadded~gte~2021-01-01 | \nFilters the returned items by the date they opted out of messages. Comparison operators (=, >, >=, <, <=) can be one of: =, ~gt~, ~gte~, ~lt~, ~lte~ | \n
| phonenumber | \nphonenumber=2145551234 | \nWill search the results for a specific phone number. | \n
| firstname | \nfirstname=john | \nWill search the result's first name for this text. | \n
| lastname | \nlastname=smith | \nWill search the result's last name for this text. | \n
| notes | \nnotes=inserted | \nWill search the result's note for this text. | \n
Example:
\n{{base_url}}/v1/donotcalls?dateadded~gte~2021-01-01&sortby=-phonenumber
Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.
\nThe response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Do Not Calls in the feed altogether. | \n
| array do-not-call Items | \nAn array of opted out numbers. | \n
| string Previous | \nThe link to the previous page of Do Not Calls in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Do Not Calls in the feed. Null on the last page. | \n
Opt out a phone number from voice messages.
\n\n| Property | \nDescription | \n
|---|---|
| string FirstName | \nThe opt out's first name. | \n
| string LastName | \nThe opt out's last name. | \n
| phone-number PhoneNumber | \nThe opted out phone number. | \n
| string Notes | \nNotes describe how the recipient opted out. | \n
The response will be an opt out model of the newly opted out contact.
\n","urlObject":{"path":["v1","donotcalls"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"561c80e7-5f18-434e-9393-52dcc10212bb","name":"Already Oped Out Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"King\",\r\n \"LastName\": \"Richard\",\r\n \"PhoneNumber\": \"2142960678\",\r\n \"Notes\": \"My Note\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/donotcalls"},"status":"The server encountered an error processing the request.","code":500,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"221"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Jun 2021 20:15:49 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"ErrorCode\": 0,\n \"ErrorName\": \"Ok\",\n \"ErrorType\": \"Informational\",\n \"Message\": \"That phone number is already on the Opt-out list.\",\n \"ExtendedData\": \"\",\n \"Source\": null,\n \"RequestedAction\": {\n \"Name\": \"None\",\n \"Data\": null\n },\n \"HttpStatusCode\": 500\n}"},{"id":"30c4e9f3-2e76-44e3-a776-cc07cd4082ec","name":"Opt Out Phone Number from Voice Messages","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FirstName\": \"King\",\r\n \"LastName\": \"Richard\",\r\n \"PhoneNumber\": \"5052053399\",\r\n \"Notes\": \"My Note\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/donotcalls"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 03 Jun 2021 20:18:49 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"FirstName\": \"King\",\n \"LastName\": \"Richard\",\n \"PhoneNumber\": \"5055553399\",\n \"Notes\": \"My Note\",\n \"OptoutDate\": \"2021-06-03 15:18:49.455-0500\",\n \"DoNotCall\": null,\n \"DoNotText\": null,\n \"GlobalOptOut\": null\n}"}],"_postman_id":"c1de41d4-9fef-4080-9284-225cfb26ab4a"}],"id":"ff7fe466-bce1-46f9-97f0-582534c35654","_postman_id":"ff7fe466-bce1-46f9-97f0-582534c35654","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"A draft-broadcast is a broadcast under construction. You can use a draft-broadcast to build a broadcast step by step setting properties on the draft-broadcast and adding contacts to it. The draft-broadcast does not send out any messages until it is submitted.
\nYou can also use a draft-broadcast to build a template broadcast, where each contact can receive a customized message. You can see how to build a template broadcast here.
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
array draft-broadcast-contact Contacts | All contacts listed here will be included in your broadcast. A PrimaryPhone is required for each contact included; the rest of the contact properties are optional.[Optional: Only required if you have not included any Lists or FileUploads.] |
The response body contains the Draft Broadcast model with the updated properties.
\n","urlObject":{"path":["v1","draftbroadcasts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"f1708df5-1815-46c0-9fa9-6d61b99779e1","name":"Create Draft Broadcast Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Contacts\": \r\n [\r\n {\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Jones\",\r\n \"PrimaryPhone\": \"(972)764-3333\",\r\n \"SecondaryPhone\": \"2141111920\",\r\n \"TertiaryPhone\": \"(972)764-4444\",\r\n \"Notes\": \"Officer\"\r\n }, \r\n { \r\n \"FirstName\": \"Mary\",\r\n \"LastName\": \"Gibson\",\r\n \"PrimaryPhone\": \"2141111920\",\r\n \"SecondaryPhone\": \"\",\r\n \"TertiaryPhone\": \"\",\r\n \"Notes\": \"\",\r\n \"IntegrationData\": \"A56CJ829\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/draftbroadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 18 Feb 2021 19:58:42 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Created\": \"2021-02-18 13:58:42.949-0600\",\n \"SingleSignOnToken\": \"43677970-a6c4-42b5-a916-33655f1c1f1b\",\n \"FailedContacts\": [\n {\n \"ErrorCode\": 203,\n \"ErrorMessage\": \"Duplicate phone number: 2141111920\",\n \"Contact\": {\n \"FirstName\": \"Mary\",\n \"LastName\": \"Gibson\",\n \"PrimaryPhone\": \"2141111920\",\n \"SecondaryPhone\": null,\n \"TertiaryPhone\": null,\n \"Notes\": \"\",\n \"IntegrationData\": \"A56CJ829\",\n \"PersonID\": 0\n }\n }\n ],\n \"DraftBroadcastID\": 221611,\n \"SingleSignOnUrl\": \"https://staging-app.call-em-all.com/sso.aspx?TemporaryKey=43677970-a6c4-42b5-a916-33655f1c1f1b\"\n}"}],"_postman_id":"2a204e12-dedc-4116-a879-0da63d47eda7"},{"name":"Add File Upload To Draft Broadcast","id":"f49ce8fd-7f68-441e-9e4f-314e5f54e763","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"A draft-broadcast is a broadcast under construction. You are able to add contacts to a draft-broadcast from a file by adding the result of a file-upload.
\nYou can see how the file upload works here.
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
string FileID | A valid FileID that was obtained from the response of a file-upload API request. |
HTTP status Success with an empty response body.
\n","urlObject":{"path":["v1","draftbroadcasts","{{DraftBroadcastID}}","fileuploads"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"c64be0cb-a455-4353-a650-46484c88995b","name":"Add File To Draft Broadcast Response Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FileID\":\"209742_20220111102019.csv\" // FileID from result of POST /fileuploads\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-rest.text-em-all.com/v1/draftbroadcasts/245075/fileuploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Tue, 11 Jan 2022 16:21:24 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"f49ce8fd-7f68-441e-9e4f-314e5f54e763"},{"name":"Apply Template To Draft Broadcast","id":"7fa33422-e49f-4aa9-9e45-54fb4980a741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This function is used to generate the custom messages for each individual contact in a template broadcast based on template variables.
\nBy default FirstName, LastName and the Notes fields are available for each contact as a template variable. If you have added the broadcast contacts via file-upload, any additional column name in the file is also available as a template variable.
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
string TextMessage | The base template that each customized message is generated from. Use the {{ .. }} brackets to name a template variable that should be substituted by the value of that variable for each contact. |
boolean HasMedia | Whether the template contains a media. Always false. Currently sending a template broadcast with images and audio is not supported. |
The response body contains the Template-Merge-Progress model that describes the result of the operation.
\n","urlObject":{"path":["v1","draftbroadcasts","{{DraftBroadcastID}}","templatemerges"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"1ab95668-5058-4b76-8c62-a2cd6175244d","name":"Template Merge Response Example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TextMessage\":\"Hello {{FirstName}}! Your scheduled service date is at {{ServiceDate}}.\",\r\n \"HasMedia\":false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://staging-rest.text-em-all.com/v1/draftbroadcasts/245075/templatemerges"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Tue, 11 Jan 2022 16:21:41 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"TemplateMerge\": {},\n \"ID\": 637774933011405543,\n \"UserID\": 209742,\n \"Status\": \"Complete\",\n \"Message\": \"Applying template merge completed.\",\n \"Total\": 52,\n \"Completed\": 52\n}"}],"_postman_id":"7fa33422-e49f-4aa9-9e45-54fb4980a741"}],"id":"84408079-66e0-4482-9a76-4b73ae0a6e4f","_postman_id":"84408079-66e0-4482-9a76-4b73ae0a6e4f","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint sets up and returns important information needed to get started using single-sign-on and when calling other endpoints
\nThe Request can contain the following properties:
\n\n| Property | Description |
|---|---|
string UserName | The user's username used to access Text-Em-All. |
string Password | The user's password used to access Text-Em-All. |
boolean FailIfUserSetupNotCompleted | If set to true, we check to see if the user has text numbers assigned and if the user has completed onboarding. If either of those are not true, InvalidLogin (in the response) will be set to true. |
array webhook-setup-object WebHooks | This object has information about the webhook notification being set up (url, notification type). [optional] |
The response body contains the Integration Setup model.
\n","urlObject":{"path":["v1","embeddedviews","setup"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"ad471425-15c0-4735-ad2e-10fbe43d4728","name":"Integration Setup Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"UserName\": \"{{username}}\",\r\n \"Password\": \"{{password}}\",\r\n \"FailIfUserSetupNotCompleted\" : \"False\", \r\n \"WebHooks\": \r\n [\r\n {\r\n \"Type\": \"BroadcastStatusChange\",\r\n \"Url\": \"https://mysite.com/mywebhook\",\r\n \"Authorization\": \"Basic c2Rmc2RmOnNkZnNkZg==\"\r\n },\r\n {\r\n \"Type\": \"TextInbound\",\r\n \"Url\": \"https://mysite.com/mywebhook\",\r\n \"Authorization\": \"Basic c2Rmc2RmOnNkZnNkZg==\"\r\n },\r\n {\r\n \"Type\": \"TextOutbound\",\r\n \"Url\": \"https://mysite2.com/mywebhook\",\r\n \"Authorization\": \"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/embeddedviews/setup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"1303"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcc2luZ2xlc2lnbm9uXHNldHVw?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 23 Feb 2021 23:39:54 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"SetupCompleted\": true,\n \"UserID\": 111111,\n \"AuthToken\": \"00000000-0000-0000-0000-000000000000\",\n \"OnboardingCompleted\": true,\n \"InvalidLogin\": false,\n \"WebHooks\": [\n {\n \"ID\": 5593,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n },\n \"Type\": \"BroadcastStatusChange\",\n \"Method\": \"Webhook\",\n \"NotificationMethodData\": null\n },\n {\n \"ID\": 5594,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n },\n \"Type\": \"TextInbound\",\n \"Method\": \"Webhook\",\n \"NotificationMethodData\": null\n },\n {\n \"ID\": 5595,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n },\n \"Type\": \"TextOutbound\",\n \"Method\": \"Webhook\",\n \"NotificationMethodData\": null\n }\n ],\n \"TextNumbers\": [\n {\n \"TextNumberID\": 11111,\n \"TextPhoneNumber\": \"18335555555\",\n \"Name\": null,\n \"Description\": null,\n \"UnreadCount\": 0,\n \"IsDefault\": false,\n \"IsBlocked\": false,\n \"FlatRateConversation\": false,\n \"FlatRateConversationStatus\": \"Inactive\",\n \"FlatRateSubscriptionEndDate\": null,\n \"TextNumberSpeed\": null\n }\n ]\n}"}],"_postman_id":"9b64d0e5-eca7-4d1d-8a59-f819852eb632"},{"name":"Create Draft Broadcast","id":"cc722c45-05bd-4702-91b1-3f8e9b6e4d68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Your client application determines the contacts to be messaged. You can then call this endpoint, and pass in the selected contacts from your application. We will return data that includes a URL to open the Text-Em-All app in a browser window, or in an iframe inside your application with the selected contacts added to the broadcast.
\nThe Request can contain the following properties:
\n\n| Property | \nDescription | \n
|---|---|
| array draft-broadcast-contact Contacts | \nAll contacts listed here will be included in your broadcast. A PrimaryPhone is required for each contact included; the rest of the contact properties are optional.[Optional: Only required if you have not included any Lists or FileUploads.] | \n
The response body contains the Draft Broadcast model with the updated properties.
\n","urlObject":{"path":["v1","embeddedviews","broadcasts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"59e1d511-ead1-4f35-9920-b0af8152f8db","name":"Create Draft Broadcast Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Contacts\": \r\n [\r\n {\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Jones\",\r\n \"PrimaryPhone\": \"(972)764-3333\",\r\n \"SecondaryPhone\": \"2141111920\",\r\n \"TertiaryPhone\": \"(972)764-4444\",\r\n \"Notes\": \"Officer\"\r\n }, \r\n { \r\n \"FirstName\": \"Mary\",\r\n \"LastName\": \"Gibson\",\r\n \"PrimaryPhone\": \"2141111920\",\r\n \"SecondaryPhone\": \"\",\r\n \"TertiaryPhone\": \"\",\r\n \"Notes\": \"\",\r\n \"IntegrationData\": \"A56CJ829\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/embeddedviews/broadcasts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Thu, 18 Feb 2021 19:58:42 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Created\": \"2021-02-18 13:58:42.949-0600\",\n \"SingleSignOnToken\": \"43677970-a6c4-42b5-a916-33655f1c1f1b\",\n \"FailedContacts\": [\n {\n \"ErrorCode\": 203,\n \"ErrorMessage\": \"Duplicate phone number: 2141111920\",\n \"Contact\": {\n \"FirstName\": \"Mary\",\n \"LastName\": \"Gibson\",\n \"PrimaryPhone\": \"2141111920\",\n \"SecondaryPhone\": null,\n \"TertiaryPhone\": null,\n \"Notes\": \"\",\n \"IntegrationData\": \"A56CJ829\",\n \"PersonID\": 0\n }\n }\n ],\n \"DraftBroadcastID\": 221611,\n \"SingleSignOnUrl\": \"https://staging-app.call-em-all.com/sso.aspx?TemporaryKey=43677970-a6c4-42b5-a916-33655f1c1f1b\"\n}"}],"_postman_id":"cc722c45-05bd-4702-91b1-3f8e9b6e4d68"},{"name":"Text Message Conversation","id":"5f7d4966-3d49-4170-bc87-707e0f4f399b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Your client application determines the contact with which to start a 1 on 1 text conversation. You can then call this endpoint, and pass in the selected contacts phone number, along with one of your Text Numbers. We will return data that includes a URL to open the Text-Em-All app, with a text message conversation, in a browser window, or in an iframe inside your application.
\nThe Request can contain the following properties:
\n\n| Property | \nDescription | \n
|---|---|
| string TextNumber | \nText number from your Text-Em-All account. The communication will be between your recipient and this number. [Required: 11 digit number - includes the leading 1] | \n
| string PhoneNumber | \nThe recipient who will receive your text messages. [Required: 10 digit number - excludes the leading 1] | \n
| string FirstName | \nThe recipient's first name. [Optional - 50 Characters Max] | \n
| string LastName | \nThe recipient's last name. [Optional - 50 Characters Max] | \n
| string Notes | \nNotes about recipient that will be displayed on the Text-Em-All website. [Optional - 50 Characters Max] | \n
| string IntegrationData | \nIntegration Data will be returned in API GETs to /conversations/single?textphonenumber=...&phonenumber=... [Optional - 512 Characters Max] | \n
| sso-conversation-customization Customization | \nThis will allow you to hide or show conversation action buttons. | \n
The response body contains the following properties:
\n\n\n| Property | \nDescription | \n
|---|---|
| string Token | \nThe unique temporary token used to single sign in a user. This token is used in the Url as a query parameter. | \n
| date-time Expires | \nThe time the token will expire. | \n
| string Url | \nYour application will be able to open up the Text-Em-All website in a new browser window or frame with this URL. | \n
| date-time Created | \nThe token creation time. | \n
Integrations that use Embedded Views will easily be able to incorporate all Text-Em-All functionality into their website or application. Developers can choose to open up the Text-Em-All app in a browser window, or in an iframe inside their application. With Embedded Views, your user is already logged in to Text-Em-All - giving them access to complete the tasks they need.
\nEmbedded View integrations are done using the Text-Em-All REST API. Developers will call an endpoint in order to receive a temporary token that can be used to open up the Text-Em-All app. This is a single use token, but will allow the user to be seamlessly logged in from your site/application. You can choose which page to land the user on and pass in information (like contact records) from your site/application.
\n","event":[{"listen":"prerequest","script":{"id":"c54ebdeb-be25-4285-8868-adde33f03b97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0bbe32cf-a8b6-4720-b6ae-8307fe8f21fa","type":"text/javascript","exec":[""]}}],"_postman_id":"a96a5dab-1d27-4778-8e20-2badf13abfdb","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The endpoint will allow you to upload a file of contacts to be used later. Please see the examples for the required and optional input properties.
\nThe Request can contain the following properties:
\n| Property | \nDescription | \n
|---|---|
| string FileName | \nThe name of your file. | \n
| string ContentType | \nThe type of file you are uploading. [Excel and CSV files are accepted] | \n
| stream Content | \nThe file being uploaded. | \n
The response body contains the file upload model with the updated properties.
\n","urlObject":{"path":["v1","fileuploads","filename.csv"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"28a93e7b-0ffc-4b86-892b-11680126c9bf","name":"Upload Contacts from File","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/csv","type":"text","disabled":true}],"body":{"mode":"file","file":{"src":"///Mac/Home/Downloads/Test.csv"},"options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/fileuploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 18 May 2021 19:41:17 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"FileID\": \"215790_20210518144112.csv\",\n \"Status\": \"Complete\",\n \"Created\": \"2021-05-18 14:41:13.126-0500\",\n \"SheetName\": null,\n \"IncludeHiddenRecords\": false,\n \"Summary\": {\n \"GoodRecordCount\": 2,\n \"BadRecordCount\": 1,\n \"DuplicateRecordCount\": 1,\n \"GoodFeedUri\": \"/fileuploads/215790_20210518144112.csv/goodrecords\",\n \"BadFeedUri\": \"/fileuploads/215790_20210518144112.csv/badrecords\",\n \"DuplicateFeedUri\": \"/fileuploads/215790_20210518144112.csv/duplicaterecords\"\n }\n}"}],"_postman_id":"5dd38487-d9d4-4154-bfde-06d566d35801"},{"name":"Get Good Records from Upload","id":"c9685b3e-041f-4865-afd3-302cdb997fb1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return an array of all contacts, that were successfully uploaded. You can use the contacts returned here for:
\nPOST /broadcastsPOST /lists/{{list_id}}/fileuploadsList or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your results with this search string. [Searches the any phone number, first name, last name, and notes with your search string]. | \n
| sortby | \nsortby=phonenumber | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-phonenumber] | \n
Example:
\n{{base_url}}/v1/fileuploads/{{file_name}}/goodrecords?page=1&pagesize=10&q=214&sortby=linenumber
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Uploaded Contacts in the feed altogether. | \n
| array uploaded-contacts Items | \nContains an array of Uploaded Contacts | \n
| string Previous | \nThe link to the previous page of Uploaded Contacts in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Uploaded Contacts in the feed. Null on the last page. | \n
This endpoint will return an array of all contacts, that were NOT successfully uploaded.
\nList or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your results with this search string. [Searches the any phone number, first name, last name, and notes with your search string]. | \n
| sortby | \nsortby=phonenumber | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-phonenumber] | \n
Example:
\n{{base_url}}/v1/fileuploads/{{file_name}}/badrecords?page=1&pagesize=10&q=214&sortby=linenumber
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Uploaded Contacts in the feed altogether. | \n
| array uploaded-contacts Items | \nContains an array of Uploaded Contacts | \n
| string Previous | \nThe link to the previous page of Uploaded Contacts in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Uploaded Contacts in the feed. Null on the last page. | \n
This endpoint will return an array of all contacts, that were NOT successfully uploaded because the primary phone was a duplicate of another row in your file.
\nList or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your results with this search string. [Searches the any phone number, first name, last name, and notes with your search string]. | \n
| sortby | \nsortby=phonenumber | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-phonenumber] | \n
Example:
\n{{base_url}}/v1/fileuploads/{{file_name}}/duplicaterecords?page=1&pagesize=10&q=214&sortby=linenumber
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Uploaded Contacts in the feed altogether. | \n
| array uploaded-contacts Items | \nContains an array of Uploaded Contacts | \n
| string Previous | \nThe link to the previous page of Uploaded Contacts in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Uploaded Contacts in the feed. Null on the last page. | \n
This endpoint will return an array of all contact lists/groups. An account owner will see all lists; sub-users will see lists based on their permission level for seeing all contact lists.
\nList or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=everyone | \nSearch your lists with this search string. [Searches the list name and ListID with your search string]. | \n
| sortby | \nsortby=name | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-name] | \n
| listtype | \nlisttype=user | \nFilters lists by their type. | \n
| rostercount | \nrostercount~lt~3 | \nFilters lists based on how may contacts are in the group. Comparison operators (=, >, >=, <, <=) can be one of: =, ~gt~, ~gte~, ~lt~, ~lte~ | \n
Example:
\n{{base_url}}/v1/lists?page=1&pagesize=10&q=ee&sortby=lastupdated
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Lists in the feed altogether. | \n
| array list Items | \nContains an array of Lists | \n
| string Previous | \nThe link to the previous page of Lists in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Lists in the feed. Null on the last page. | \n
This endpoint will return a single contact lists/group. The System List everyone, can be obtained by using GET /v1/lists/everyone
The response body contains the list model.
\n","urlObject":{"path":["v1","lists","{{list_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0650b189-b0ae-4056-8367-d27a31c8d31b","name":"Get Single List","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/lists/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:35:32 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/lists/3\",\n \"ListID\": 3,\n \"ListType\": \"User\",\n \"ListName\": \"Engineers\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2021-02-25 09:20:57.58-0600\",\n \"RosterCount\": 6\n}"}],"_postman_id":"eed435f2-e21b-40d9-985c-6a90714d2d7f"},{"name":"Create New Group","id":"c531e7fd-4fef-4bcc-b8c9-ecbedd01aa33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will allow you to create a new list/group. Please see the examples for the required and optional input properties.
\nThe Request can contain the following properties:
\n| Property | \nDescription | \n
|---|---|
| string ListName | \nA short name of the contact group. [Required: 75 characters max] | \n
| string ListDescription | \nA longer description of the contact group. [Optional: 150 characters max] | \n
| boolean IsAutoReplyOn | \nWhen the flag is set to true on the group the AutoReplyMessage will be sent as an automatic reply to all phone numbers opting in to the group. [Optional: defaults to false] | \n
| string AutoReplyMessage | \nThis is the auto reply message sent to a phone number joining/opting-in to the group when the IsAutoReplyOn flag is set to true. [Optional: 160 characters max] | \n
The response body contains the List model with the updated properties.
\n","urlObject":{"path":["v1","lists"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"93aa7aa6-2a56-4b76-9239-c3af4407294e","name":"Create New Group","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ListName\": \"New Employees\",\r\n \"ListDescription\": \"Newly hired employees\",\r\n \"IsAutoReplyOn\": true,\r\n \"AutoReplyMessage\": \"Please reach out to Chanelle with any questions!\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/lists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 19:43:41 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/lists/4\",\n \"ListID\": 4,\n \"ListType\": \"User\",\n \"ListName\": \"New Employees\",\n \"ListDescription\": \"Newly hired employees\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": true,\n \"AutoReplyMessage\": \"Please reach out to Chanelle with any questions!\",\n \"LastUpdated\": \"2021-05-17 14:43:41.46-0500\",\n \"RosterCount\": 0\n}"}],"_postman_id":"c531e7fd-4fef-4bcc-b8c9-ecbedd01aa33"},{"name":"Update Group Details","id":"2d7f31db-1edc-4261-8d9c-b5519126e940","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The request body contains a list model describing the new values to be updated. Only properties you include will be updated; all others will stay the same.
\nThe response body contains the list model with the updated properties.
\n","urlObject":{"path":["v1","lists","{{list_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"895d6ee0-3aa5-4063-b778-9d0c037ee081","name":"Update Group Details","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"ListName\": \"New Employees\",\r\n \"ListDescription\": \"Newly hired employees\",\r\n \"IsAutoReplyOn\": true,\r\n \"AutoReplyMessage\": \"Please reach out to Chanelle with any questions!\",\r\n \"ListID\": 4,\r\n \"SMSName\": \"NEW\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/lists/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:18:30 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"Uri\": \"/v1/lists/4\",\n \"ListID\": 4,\n \"ListType\": \"User\",\n \"ListName\": \"New Employees\",\n \"ListDescription\": \"Newly hired employees\",\n \"SMSName\": \"NEW\",\n \"IsAutoReplyOn\": true,\n \"AutoReplyMessage\": \"Please reach out to Chanelle with any questions!\",\n \"LastUpdated\": \"2021-05-17 15:18:30.927-0500\",\n \"RosterCount\": 0\n}"}],"_postman_id":"2d7f31db-1edc-4261-8d9c-b5519126e940"},{"name":"Delete a Group","id":"b346d832-4922-466c-a525-a7bf98c9b23f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This request will delete a list/group.
\nThe response is a HTTP Response Status Code
\n","urlObject":{"path":["v1","lists","{{list_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"0dfd349f-4e20-4f29-be7e-1dbf6df8fee3","name":"Delete a Group Success Response","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/lists/{{list_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:26:50 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"4542fcea-8606-4f77-82f7-f59249738e10","name":"No Matching ListID to Delete","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/lists/{{list_id}}"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:27:18 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b346d832-4922-466c-a525-a7bf98c9b23f"},{"name":"Get List Contacts","id":"6fe02e7a-ee95-4989-be14-ead17ec782de","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return an array of all contact members in a list/group. You can obtain the contacts for the everyone list with GET /v1/lists/everyone/contacts.
List or search contacts. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your list contacts with this search string. [Searches the contact's first name, last name and notes with your search string]. | \n
| sortby | \nsortby=firstnamelastname | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-firstnamelastname] | \n
| voiceoptouts | \nvoiceoptouts=true | \nIf true, will return all contacts who are opted out of voice messages. If false, will return all contacts who are not opted out of voice messages. | \n
| smsoptins | \nsmsoptins=true | \nReturns all contacts who have texted \"Join\" to one of your text numbers. You can use this if you want to require contacts to opt in. | \n
| smsoptouts | \nsmsoptouts=true | \nReturns all contacts who are opted out of text messages. | \n
Example:
\n{{base_url}}/v1/lists/{{list_id}}/contacts?q=doe?sortby=firstnamelastname
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Contacts in the feed altogether. | \n
| array contact Items | \nContains an array of Contacts | \n
| string Previous | \nThe link to the previous page of Contacts in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Contacts in the feed. Null on the last page. | \n
This request will delete a single contact from a list/group.
\nThe response is a HTTP Response Status Code
\n","urlObject":{"path":["v1","lists","{{list_id}}","contacts","{{contact_id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"593272ac-3932-4c90-b377-8759d3789943","name":"Remove Single Contact From List Response","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/lists/{{list_id}}/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:50:36 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"7a325877-6d7b-486a-a938-dfc612aeec54"},{"name":"Remove All Contacts From a Group","id":"e028de21-3865-47e6-a685-6838a3867fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This request will delete all contacts from a list/group. You can delete the contacts in the everyone or deleted list with:
\nDELETE /v1/lists/everyone/contacts
DELETE \n /v1/lists/deleted/contacts.
The response is a HTTP Response Status Code
\n","urlObject":{"path":["v1","lists","{{list_id}}","contacts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"5b87b80b-7b00-4a71-bfc6-c99d160e1e9a","name":"Remove Single Contact From List Response","originalRequest":{"method":"DELETE","header":[],"url":"{{base_url}}/v1/lists/{{list_id}}/contacts/{{contact_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 17 May 2021 20:50:36 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"e028de21-3865-47e6-a685-6838a3867fe4"},{"name":"Add Contacts to Group from File Upload","id":"428ddf8b-a868-43a4-a872-4bd3236f8a2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This request will add contacts to a list/group from a file upload. You can add contacts to the everyone list with:
\nPOST\n /v1/lists/everyone/fileuploads.
The Request can contain the following properties:
\n| Property | \nDescription | \n
|---|---|
| string FileID | \nThe id returned when you POST /fileuploads. | \n
The response body contains the file upload progress model with the updated properties.
\n","urlObject":{"path":["v1","lists","{{list_id}}","fileuploads"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"e53d6b98-631a-4ed7-be47-2f3e5b9e8974","name":"Add Contacts to Group from File Upload","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FileID\": \"215790_20210518144112.csv\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/lists/{{list_id}}/fileuploads"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"45"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcQ2FsbC1FbS1BbGxcUmVzdFxjZWEtcmVzdC1hcGlccmVzdC5jYWxsLWVtLWFsbC5jb21cdjFcbGlzdHNcMVxmaWxldXBsb2Fkcw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 18 May 2021 20:06:29 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"Status\": \"Complete\",\n \"Total\": 4,\n \"Completed\": 4\n}"}],"_postman_id":"428ddf8b-a868-43a4-a872-4bd3236f8a2e"}],"id":"1947f1f7-a711-4b11-a545-e9d4f6d3449d","_postman_id":"1947f1f7-a711-4b11-a545-e9d4f6d3449d","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Returns a list of notifications.
\n\nQuery parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
Example:
\n{{base_url}}/v1/notifications?pagesize=10
Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.
\nThe response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of opt outs in the feed altogether. | \n
| array notification Items | \nAn array of notifications. | \n
| string Previous | \nThe link to the previous page of opt outs in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of opt outs in the feed. Null on the last page. | \n
This endpoint allows you to add a new notification. Notifications can be sent via email, text or webhook. Notifications will be send on the days, hours and frequency of your choosing.\n\n
The response body contains the following properties:
\n\n| Property | Description |
|---|---|
notification-method Method | Describes how you want to receive your notifications. |
notification-type Type | The type refers to the event your want to receive notifications about. |
boolean IsActive | Describes if the notification should be active or not. [Defaults to True.] |
integer PeriodMinutes | Describes the frequency you want to be notified in your notification window. [Optional. Commonly used for UnreadMessage type notifications.] |
notification-window NotificationWindow | Describes the days and hours you want to receive notifications. [Optional. Commonly used for UnreadMessage type notifications.] |
array object NotificationMethodData | Key-Value pairs that describe where to send a webhook notification. It can include an object for any authorization that may be required. [Optional. Used for webhook notifications.] |
The response is the newly created
\n\nwith the updated properties.
\n","urlObject":{"path":["v1","notifications"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a2602190-76d7-4ddd-a6cd-02c692edf0b7","name":"Notification Setup Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"IsActive\": true,\r\n \"NotificationWindow\": {\r\n \"Days\": [\r\n \"Monday\",\r\n \"Tuesday\",\r\n \"Wednesday\",\r\n \"Thursday\",\r\n \"Friday\",\r\n \"Saturday\",\r\n \"Sunday\"\r\n ],\r\n \"StartTimeOfDay\": {\r\n \"Hour\": 9,\r\n \"Minute\": 0\r\n },\r\n \"StopTimeOfDay\": {\r\n \"Hour\": 21,\r\n \"Minute\": 0\r\n },\r\n \"startTimeText\": \"9:00 AM\",\r\n \"stopTimeText\": \"9:00 PM\"\r\n },\r\n \"PeriodMinutes\": 60,\r\n \"Method\": \"Email\",\r\n \"Type\": \"TextOutbound\",\r\n \"Url\": \"https://mysite2.com/mywebhook\",\r\n \"Authorization\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Thu, 30 Sep 2021 16:39:27 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"ID\": 6597,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 9,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 21,\n \"Minute\": 0\n }\n },\n \"Type\": \"TextOutbound\",\n \"Method\": \"Email\",\n \"NotificationMethodData\": null\n}"}],"_postman_id":"219e9504-8285-4939-9a12-74d25cc4fa94"}],"id":"2d820046-edc4-4128-8e30-7aa9e254b13f","_postman_id":"2d820046-edc4-4128-8e30-7aa9e254b13f","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"List or search phone numbers who have opted out of of your messages.
\n\nQuery parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| sortby | \nsortby=dateadded | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-dateadded] | \n
| date-from | \ndate-from=2021-01-01 | \nGet all opt outs where the recipient opt out date is after or equal to this value. | \n
| date-to | \ndate-to=2021-02-01 | \nGet all opt outs where the recipient opt out date is before or equal to this value. | \n
| optout-status | \noptout-status=both | \nFilter the results by their opt out status. [Can be one of: voice, text or both] | \n
Example:
\n{{base_url}}/v1/optouts?optout-status=voice&sortby=-dateadded
Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.
\nThe response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of opt outs in the feed altogether. | \n
| array opt-out Items | \nAn array of opted out numbers. | \n
| string Previous | \nThe link to the previous page of opt outs in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of opt outs in the feed. Null on the last page. | \n
This endpoint will allow you to update the opt in/out status of a phone number.
\n\n| Property | Description |
|---|---|
phone-number PhoneNumber | The phone number to be updated. |
boolean DoNotCall | The phone number will be opted out of voice messages if this value is true. Alternately, the number will be opted in to voice messages if set to false. |
boolean DoNotText | The phone number will be opted out of text messages if this value is true. Alternately, the number will be opted in to text messages if set to false. |
The response will be an opt out model with the updated properties.
\n","urlObject":{"path":["v1","optouts"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"78286184-9e69-4b66-9eb2-3c4463a2548a"},{"name":"Opt Out of Group Code Accounts","id":"b48c9dd4-0714-40d2-b033-0f06f0256e52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"PhoneNumber\": \"2145551332\",\r\n \"DoNotCall\": true,\r\n \"DoNotText\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/optouts/groupcodes/{{group_code_name}}","description":"Text-Em-All allows larger organizations to have multiple accounts. These are accounts are connected by a shared group code. You can use this API endpoint to opt-out a phone number from all Text-Em-All accounts that share your organization's group code.
\n\n| Property | Description |
|---|---|
phone-number PhoneNumber | The phone number to be opted out of all accounts that share the group code specified in the request's URL. |
boolean DoNotCall | The phone number will be opted out of voice messages if this value is true. Otherwise it has no effect. |
boolean DoNotText | The phone number will be opted out of text messages if this value is true. Otherwise it has no effect. |
The response will be a group code opt out model with the updated properties.
\n","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The credit balance report lists all credit adjustments to the balance of credits of a Pay As You Go account including purchasing and using credits.
\nQuery parameters in the request can be used to filter and sort the result.
The request can contain the following query parameters:
\n\n| Parameter | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| sortby | \nsortby=dateadded | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-dateadded] | \n
| date-from | \ndate-from=2021-01-01 | \nGet all opt outs where the recipient opt out date is after or equal to this value. | \n
| date-to | \ndate-to=2021-02-01 | \nGet all opt outs where the recipient opt out date is before or equal to this value. | \n
| userid | \nuserid=123456 | \nReturn credit events only related to to the user specified. | \n
| credittypedescription | \ncredittypedescription=Purchase | \nReturn only specific type of credit events. See here for a list of available values. |
The endpoints in this section will allow you to request or download the same data that you can access in the report section of the Text-Em-All website.
\n","_postman_id":"a89c033e-36de-42f3-bfa4-ab6be81c434b","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"A template broadcast is a special text broadcast where each individual contact receives a customized message. The message are put together from a base template that you can use to insert customized data into to create the individualized messages.
\nFor example if a template text looks like:
\nHi {{FirstName}}, your appointment is scheduled at {{AppointmentDate}}.
And your broadcast has contacts with custom data named FirstName and AppointmentDate, then you are able to generate a template broadcast where one messages sent out might look like this:
\nHi John, your appointment is schedule for next Tuesday at 9AM.
To create a template broadcast you need to build it step by step. Please see each individual step for more details.
\n\nThe Contacts field in the API request is empty as contacts will be added to the draft-broadcast by file upload.
\nThe API response returns a DraftBroadcastID field that you will need to use in the following API calls.
\nUpload a contact file with custom data
\nThe file-name in the API request URL can be anything, but please use the correct file extension to specify the content. (E.g. csv for comma delimited file, xls or xlsx for excel files.)
\nThe API response returns a FileID field that you will need to use in the following API calls.
\nAdd the contacts from the file to the draft-broadcast
\nApply the customization data to the template
\nUse the DraftBroadcastID received from the previous API calls.
\nYou can build the template message from free text, the {{FirstName}}, {{LastName}}, {{Notes}} default contact variables and any of the file-upload's custom column names.
\nUse the DraftBroadcastID received from the previous API calls.
\nPlease consider setting the Broadcast Name, so that the user later can identify it from the list of broadcasts on the Text-Em-All home page.
\nThe TextMessage field in the API request is not used to as the message, but it is displayed on the Text-Em-All broadcast summary page, so it is recommended to have it match the base template text.
\nThe TextNumberID ID in the API request determines the toll free number that the messages are sent from. If the field is omitted, the default text-number assigned to the user is used. If the field is omitted and there is no default text-number assigned to the user, the API request fails.
\nThis endpoint will return an array of all text numbers. As an account owner you will see all text numbers associated with the account; sub-users will only see text numbers assigned to them.
\nList or search text numbers. Query parameters in the request can be used to filter and sort the result.
\n\nThe request can contain the following query parameters:
\n\n| Query Param | Example | Description |
|---|---|---|
page | page=1 | The page number. |
pagesize | pagesize=10 | The number of items a page has. |
takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
q | q=doe | Search your text numbers with this search string. [Searches the text number's phone number, name and description with your search string]. |
sortby | sortby=name | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-name] |
status | status=1 | Status of a text number. [Requested=0, Active=1, Denied=2, Retired=3] |
flatrateconversation | flatrateconversation=true | If true, will return all text numbers enabled for flat rate conversations. If false, will return all text numbers NOT enabled for flat rate conversations. |
isdefault | isdefault=true | If true, returns the single default text number; false will return all the other text numbers without the default. |
browsernotifications | browsernotifications=true | If true, returns all text numbers enabled for browser notifications. False returns all numbers not enabled for browser notifications. |
Example:
\n\n{{base_url}}/v1/textnumbers?page=1&pagesize=10&q=833&sortby=name
The response body contains the following properties:
\n\n| Property | Description |
|---|---|
integer Size | The total number of Text Numbers in the feed altogether. |
array text-number Items | Contains an array of Text Numbers |
string Previous | The link to the previous page of Text Numbers in the feed. Null on the first page. |
string Next | The link to the next page of Text Numbers in the feed. Null on the last page. |
This endpoint will return an array of broadcast replies.
\nList or search broadcast replies. Query parameters in the request can be used to filter and sort the result.
\nThe request can contain the following query parameters:
\n| Query Param | \nExample | \nDescription | \n
|---|---|---|
| page | \npage=1 | \nThe page number. | \n
| pagesize | \npagesize=10 | \nThe number of items a page has. | \n
| takesize | \ntakesize=10 | \nHow many items to return (Generally should equal to pagesize). | \n
| q | \nq=doe | \nSearch your text numbers with this search string. [Searches the text number's phone number, name and description with your search string]. | \n
| sortby | \nsortby=phonenumber | \nSort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-phonenumber] | \n
| textresponseid | \ntextresponseid~gt~1223533 | \nFilter responses by their TextResponseId. The highest TextResponseId is commonly stored to be used the next time you call this endpoint for the most recent replies. Comparison operators (=, >, >=, <, <=) can be one of: =, ~gt~, ~gte~, ~lt~, ~lte~ | \n
| phonenumber | \nphonenumber=2145551234 | \nFilter text responses based on the phone number that replied. | \n
| notes | \nnotes=engineers | \nFilter replies based on the notes for all contacts/recipients. | \n
| broadcastid | \nbroadcastid=10009225 | \nFilter replies based on the broadcast the reply is attributed to. | \n
| status | \nstatus=NotRead | \nFilter replies based on their status. [Can be one of: NotRead, Read, Deleted] | \n
| received | \nreceived~gt~2021-01-01 | \nFilter responses by the day the response was received. Comparison operators (=, >, >=, <, <=) can be one of: =, ~gt~, ~gte~, ~lt~, ~lte~ | \n
Example:
\n{{base_url}}/v1/textresponses?broadcastid=10009225&received~gt~2021-01-01&sortby=phonenumber
The response body contains the following properties:
\n| Property | \nDescription | \n
|---|---|
| integer Size | \nThe total number of Text Responses in the feed altogether. | \n
| array text-response Items | \nContains an array of Text Responses. | \n
| string Previous | \nThe link to the previous page of Text Responses in the feed. Null on the first page. | \n
| string Next | \nThe link to the next page of Text Responses in the feed. Null on the last page. | \n
This endpoint will return a collection of Text Templates. As an account owner you will see all text templates associated with the account; sub-users will only see text templates that they have access to.
\nList or search text templates. Query parameters in the request can be used to filter and sort the result.
The request can contain the following query parameters:
| Query Param | Example | Description |
|---|---|---|
| page | page=1 | The page number. |
| pagesize | pagesize=10 | The number of items a page has. |
| takesize | takesize=10 | How many items to return (Generally should equal to pagesize). |
| q | q=doe | Search your text templates with the template name containing this search string. |
| sortby | sortby=name | Sort the results using one of these sort options. [Include a minus in front of the value to sort in descending order. ex: sortby=-name] |
| type | type=text | Template type of a text template. |
| shared | shared=true | Filter for text templates that are shared or not shared across multiple Text=-Em-All accounts. |
| isfavorite | isfavorite=true | Filter for text templates that are marked with a Star as favorite in the message library. |
Example:
{{base_url}}/v1/templates?page=1&pagesize=10&q=job&sortby=name
The response body contains the following properties:
| Property | Description |
|---|---|
| integer Size | The total number of Text Templates in the feed altogether. |
| array text-template Items | Contains an array of Text Templates |
| string Previous | The link to the previous page of Text Templates in the feed. Null on the first page. |
| string Next | The link to the next page of Text Templates in the feed. Null on the last page. |
Text templates are text messages that users saved in the Text Message Library so they can be used as the message in text broadcasts or conversation messages.
\n","_postman_id":"bc259946-0dc4-4763-a23b-09fe93220673","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint allows you to preview available text-to-speech voice options.
\n","urlObject":{"path":["v1","audio","texttospeech","voices"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"62ed85d3-d938-4ff6-815f-d5d2fdc0b068","name":"Get Text-To-Speech Audio Voices Response","originalRequest":{"method":"GET","header":[],"url":"{{base_url}}/v1/audio/texttospeech/voices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"Id\": {\n \"Value\": \"Joanna\"\n },\n \"Name\": \"Joanna\",\n \"Language\": \"English\",\n \"Gender\": \"Female\",\n \"Provider\": null\n },\n {\n \"Id\": {\n \"Value\": \"Salli\"\n },\n \"Name\": \"Salli\",\n \"Language\": \"English\",\n \"Gender\": \"Female\",\n \"Provider\": null\n },\n {\n \"Id\": {\n \"Value\": \"Matthew\"\n },\n \"Name\": \"Matthew\",\n \"Language\": \"English\",\n \"Gender\": \"Male\",\n \"Provider\": null\n },\n {\n \"Id\": {\n \"Value\": \"Joey\"\n },\n \"Name\": \"Joey\",\n \"Language\": \"English\",\n \"Gender\": \"Male\",\n \"Provider\": null\n }\n]"}],"_postman_id":"9ed6278e-0e4d-41d5-ab9c-4063bd85a8a9"},{"name":"Preview Text-To-Speech Audio","id":"870d9f89-dd7d-4d91-86b6-1dfbe718f4ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint allows you to preview a text-to-speech audio file before it is saved to your account's audio library. This is useful if you want to hear what the text will sound like before saving the audio, or before associating the voice message with a broadcast.
\nThe audio response is a raw Content-Type: audio/mpeg or Content-Type: audio/wav file depending on the file extension (the value of {{ext}} provided) in the request.
This endpoint allows you to generate and save a text-to-speech audio file to your account's audio library. This allows the same audio to be re-used for multiple broadcasts.
\nThis endpoint will return an Audio object. You can then view the audio in your account's audio library, or via the GET audio endpoints. Audio can then be attached to any kind of Voice broadcast.
\n","urlObject":{"path":["v1","audio","texttospeech"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"a4cc5172-d7dc-4657-adc2-7cac1eb2e1f8","name":"Text-To-Speech Audio Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TextToSpeech\": true,\r\n \"Text\": \"This audio will play if the person answers on the phone. We have immediate openings for the evening shift. If you are available to work, please press 0 to be transferred to the scheduling team.\",\r\n \"Voice\": \"Joanna\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/audio/texttospeech"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"64148","description":"","type":"text"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"content-range","value":"bytes 0-64147/64148","description":"","type":"text"},{"key":"accept-ranges","value":"bytes","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Uri\": null,\r\n \"AudioID\": \"as3051\",\r\n \"Name\": null,\r\n \"Description\": null,\r\n \"Favorite\": false,\r\n \"Shared\": null,\r\n \"Length\": 10,\r\n \"MessageType\": \"Never Used\",\r\n \"ReadOnly\": false,\r\n \"Created\": \"2025-09-17 15:49:34-0500\",\r\n \"LastUsed\": null,\r\n \"TextToSpeech\": true,\r\n \"Text\": \"This audio will play if the person answers on the phone. We have immediate openings for the evening shift. If you are available to work, please press 0 to be transferred to the scheduling team.\",\r\n \"Voice\": \"Joanna\"\r\n}"}],"_postman_id":"1057f63c-163b-43a6-b5e2-8db737596968"}],"id":"8f5a9da8-9fdf-49e9-9f06-4561213b5fa3","_postman_id":"8f5a9da8-9fdf-49e9-9f06-4561213b5fa3","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"Using this endpoint a user can get data and settings about their own user. To get information about other users call GET /account/users.
The response body contains a User model with the updated properties.
","urlObject":{"path":["v1","user"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"6c47fb48-278a-4d42-857b-9751aa485c93","name":"Get Current User","originalRequest":{"method":"GET","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{base_url}}/v1/user"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 May 2021 21:04:03 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 222222,\n \"UserName\": \"test-payg-user@gmail.com\",\n \"FirstName\": \"API\",\n \"LastName\": \"User\",\n \"Email\": \"test-payg-user@gmail.com\",\n \"Phone\": \"2142960678\",\n \"CallerID\": \"2142960678\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": true,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": false\n }\n}"}],"_postman_id":"573e20dc-e28a-4b64-942f-2c3869d77145"},{"name":"Update Current User","id":"653f0f1b-5c17-48ad-8d9c-b4d83b55ac8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"Calling this endpoint you can change the current user's properties. An account owner can update other users by calling PUT /account/user/{{user_id}}.
\nThe request body contains a User model describing the new values to be updated. Only properties you include will be updated; all others will stay the same.
\nThe response body contains the User model with the updated properties.
\n","urlObject":{"path":["v1","user"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"51327d1a-08bb-4e53-aa67-884440c80435","name":"Modify User's Name","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"FirstName\": \"Jane\",\r\n \"LastName\": \"Doe\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:52:47 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"},{"id":"2266aef8-391e-40c3-b06c-9cbf684d2ce8","name":"Modify Voice Settings","originalRequest":{"method":"PUT","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}},\r\n \"CallerIDNumber\": \"2149221200\",\r\n \"DefaultRetryTimes\": 2,\r\n \"DefaultMaxMessageLength\": 90,\r\n \"CallThrottle\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/account/users/{{user_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 31 Jul 2020 07:58:37 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 214810,\n \"UserName\": \"82307966\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"random_email387783@gmail.com\",\n \"Phone\": \"2149221200\",\n \"CallerID\": \"2149221200\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": false,\n \"AuthToken\": null,\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": false,\n \"CanSeeAllRoster\": false,\n \"CanSeeAllAudio\": false,\n \"CanSeeGroupAudio\": false\n }\n}"}],"_postman_id":"653f0f1b-5c17-48ad-8d9c-b4d83b55ac8e"},{"name":"Login User","id":"7a89e186-7523-4619-93c7-b9fa32e6dc97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"6e4760da-41c6-4b5d-b3d7-fd225100f63b","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"This endpoint retrieves a user's Authorization Token.
\nLike all endpoints, this one requires OAuth as part of request validation. Normally, OAuth requires the use of an Application Key, your account's Secret Key and the user's Authorization Token. However, you can't know the user's Authorization Token without calling this endpoint. Therefore, for this endpoint generate the OAuth signature from the Application Key and Secret Key normally, but use any GUID for the Authorization Token.
\nUser Authentication Tokens are good for several days and can be cached. We ask that you cache Authentication Tokens for each user in your organization and reuse them until they expire. You'll know that a token has expired when a request returns an HTTP status code of 401 - Unauthorized. At that point, simply request a new token, cache it, and use it until it expires. Rinse and repeat.
| Property | \nDescription | \n
|---|---|
| string UserName | \nThe user's Text-Em-All Username used to sign in. | \n
| string PinCode | \nThe user's Text-Em-All Password used to sign in. | \n
The response body contains a User model with the updated properties.
","urlObject":{"path":["v1","user","login"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"98a123a2-7579-4fb6-8d0c-8d34ecd03d0f","name":"Login User","originalRequest":{"method":"POST","header":[{"key":"Accept","type":"text","value":"application/json"},{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"UserID\": {{user_id}}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/user/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Fri, 14 May 2021 21:29:04 GMT"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"PinCode\": null,\n \"UserID\": 222222,\n \"UserName\": \"test-payg-user@gmail.com\",\n \"FirstName\": \"Jane\",\n \"LastName\": \"Doe\",\n \"Email\": \"test-payg-user@gmail.com\",\n \"Phone\": \"2142960678\",\n \"CallerID\": \"2142960678\",\n \"IsAccountAdmin\": false,\n \"IsMasterUser\": true,\n \"AuthToken\": \"00000000-0000-0000-0000-000000000000\",\n \"State\": null,\n \"Permissions\": {\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": false\n }\n}"}],"_postman_id":"7a89e186-7523-4619-93c7-b9fa32e6dc97"}],"id":"971256e9-5893-457a-b770-9e0d9b5d6162","_postman_id":"971256e9-5893-457a-b770-9e0d9b5d6162","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint will return the delivery receipt for the given text message ID.
\nThe response body is a [Text Delivery Receipt](#fd4398b2-5acb-4521-87da-4bf5a09bdad3) model.
","urlObject":{"path":["v1","text-messages","{{textMessageId}}","delivery-receipt"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"54ced23b-d536-4eae-ac98-4f2e4ae232be","name":"Search Text Templates","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{base_url}}/v1/templates?q=survey","host":["{{base_url}}"],"path":["v1","templates"],"query":[{"key":"q","value":"survey"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Tue, 31 May 2022 21:38:44 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"Size\": 1,\n \"Items\": [\n {\n \"TemplateID\": 3973,\n \"TemplateName\": \"Health survey\",\n \"TemplateText\": \"Good Morning {{firstname}}. Please fill out your survey here: {{Link}}\",\n \"TemplateType\": \"ConversationReply\",\n \"Created\": \"2021-12-17T09:14:47.033\",\n \"ReadOnly\": false,\n \"IsShared\": false,\n \"IsFavorite\": false,\n \"IsActive\": true,\n \"HasCustomField\": true\n }\n ],\n \"Previous\": null,\n \"Next\": null\n}"}],"_postman_id":"beef7825-db9a-4490-aa4f-1e486643f9fb"}],"id":"a5c1a0c9-bbce-4986-9a4a-7f91fdbd92a2","_postman_id":"a5c1a0c9-bbce-4986-9a4a-7f91fdbd92a2","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint allows you to delete a webhook by passing in the unique webhook Id.
","urlObject":{"path":["v1","webhooks","{{id}}"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"585b7723-ef4e-415d-aee2-afc5de4bada5"},{"name":"Create New Webhook","id":"7c6187ec-cc04-49c6-90a3-96aa3198a122","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"This endpoint allows you to add a new webhook.
\n\nThe request body contains the following properties
\n\nThe response is the id of the newly created webhook.
\n","urlObject":{"path":["v1","webhooks"],"host":["{{base_url}}"],"query":[],"variable":[]}},"response":[{"id":"897a97b1-5104-4867-9bee-2e09b6318f10","name":"Webhook Setup Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Type\": \"BroadcastStatusChange\",\r\n \"Url\": \"webhookurl\",\r\n \"AuthorizationHeader\": \"header\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}/v1/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Thu, 30 Sep 2021 16:39:27 GMT"},{"key":"content-encoding","value":"gzip"},{"key":"transfer-encoding","value":"chunked"},{"key":"vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"WebHookID\": 1234\n}"}],"_postman_id":"7c6187ec-cc04-49c6-90a3-96aa3198a122"}],"id":"e9fbf330-4462-4116-a3f5-87cbb1aee3b2","_postman_id":"e9fbf330-4462-4116-a3f5-87cbb1aee3b2","description":"","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The API endpoints available in the Text-Em-All Rest API.
\n","auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerSecret":"{{secret_key}}","consumerKey":"{{app_key}}","signatureMethod":"The highest level view of your Text-Em-All settings and data.
\n{\n \"Uri\": null,\n \"AccountID\": 260283,\n \"MonthlyLevel\": 0,\n \"MonthlyFee\": 0,\n \"SubscriptionEndDate\": null,\n \"CompanyName\": \"Home\",\n \"Address1\": \"1717 Harwood St.\",\n \"Address2\": null,\n \"City\": \"Dallas\",\n \"State\": \"TX\",\n \"Zip\": \"75201\",\n \"CallBalance\": 1700,\n \"AvailableCallUnits\": 1700,\n \"PendingCallBalance\": 0,\n \"MessengerCount\": 7\n}\n\n| Property | Description |
|---|---|
long AccountID | The account's unique identifier. |
string Address1 | The first line of the billing address for the company. |
string Address2 | The second line of the billing address for the company. |
decimal AvailableCallUnits | For credit accounts. The number of call units (credits) the account has for making calls and sending texts. This number is the difference between CallBalance and PendingCallBalance. [Only included for Pay As You Go type billing] |
decimal CallBalance | For credit accounts. The number of call units (credits) the account has. The balance will be reduced when a broadcast completes. [Only included for Pay As You Go type billing] |
string City | The billing address's city. |
string CompanyName | The billing company name. |
integer MessengerCount | The number of additional users created on the account. |
decimal MonthlyFee | For subscription accounts. The monthly subscription fee. [Only included for Monthly type billing] |
integer MonthlyLevel | For subscription accounts. The monthly subscription level. The maximum number of unique phone numbers the account can contact for the same month. [Only included for Monthly type billing] |
decimal PendingCallBalance | For credit accounts. The number of credits to be used by pending broadcasts. [Only included for Pay As You Go type billing] |
string State | The billing address's state. |
date-time SubscriptionEndDate | For subscription accounts. The end of the monthly billing cycle. [Only included for Monthly type billing] |
string Uri | The link to self. |
string Zip | The billing address's zip code. |
This contains information about an audio file in your message library or an audio file used on a voice broadcast.
\n{\n \"Uri\": \"/v1/audio/ag3472\",\n \"AudioID\": \"ag3472\",\n \"Name\": \"Wake up reminder\",\n \"Description\": \"This is my morning wake up reminder.\",\n \"Favorite\": false,\n \"Shared\": false,\n \"Length\": 11,\n \"MessageType\": \"Announcement\",\n \"ReadOnly\": false,\n \"Created\": \"2018-05-16 16:45:59-0500\",\n \"LastUsed\": \"2018-09-26 16:11:09-0500\",\n \"TextToSpeech\": false,\n \"Text\": \"If Audio ID is empty and Text to Speech is true, this text will be turned into audio.\",\n \"Voice\": \"Justin\",\n}| Property | \nDescription | \n
|---|---|
| string Uri | \nThe link to self. | \n
| string AudioID | \nThe audio resource's unique identifier. | \n
| string Name | \nThe name of the audio entered by the user. | \n
| string Description | \nA description of the audio entered by the user. | \n
| boolean Favorite | \nWhether the audio is marked as favorite. | \n
| boolean Shared | \nWhether the audio is shared with all account users. | \n
| integer Length | \nThe audio length in seconds. | \n
| audio-type MessageType | \nThe audio type. | \n
| boolean ReadOnly | \nWhether the audio cannot be deleted by the user. | \n
| datetime Created | \nThe audio creation time. | \n
| datetime LastUsed | \nThe last time the audio was used in a broadcast. | \n
| boolean TextToSpeech | \nWhether the audio was created using text to speech. | \n
| string Text | \nA transcription of the audio. | \n
| voice Voice | \nThe voice used to create a Text-To-Speech audio. | \n
This model contains high level information about a broadcast.
\n{\n \"Uri\": \"/v1/broadcasts/10006259\",\n \"UriBroadcastDetails\": \"/v1/broadcasts/10006259/details\",\n \"BroadcastID\": 10006259,\n \"BroadcastName\": \"Testing Alert System 10/27/2020\",\n \"BroadcastType\": \"Announcement\",\n \"BroadcastStatus\": \"MessageRecorded\",\n \"BroadcastStatusCategory\": \"Processing\",\n \"CreatedDate\": \"2020-10-27 15:55:22-0500\",\n \"StartDate\": \"2020-10-27 17:15:00-0500\",\n \"CompletedDate\": null,\n \"CallerID\": \"2142960678\",\n \"CreditsUsed\": null,\n \"MaxCreditCost\": 2.00,\n \"PhoneNumberCount\": 2,\n \"TotalCompleted\": 0,\n \"User\": {\n \"UserID\": 215790,\n },\n \"TransferAndConnect\": null,\n \"Audio\": {\n \"Uri\": \"/v1/audio/ah2439\",\n \"AudioID\": \"ah2439\",\n \"Length\": 14\n },\n \"AudioVM\": null,\n \"RetryTimes\": 1,\n \"CallThrottle\": 0,\n \"LivePersonTotal\": 0,\n \"AnsweringMachineTotal\": 0,\n \"BusyNoAnswerTotal\": 0,\n \"InvalidNumberTotal\": 0,\n \"SurveyResponseTotal\": 0,\n \"TransferTotal\": 0,\n \"SurveyResponses\": null,\n \"MaxMessageLength\": 30,\n \"MessageRecordingInstruction\": null,\n \"EstimatedDuration\": 0,\n \"EstimatedCompletion\": null,\n \"ExcludedDaysIgnored\": false,\n \"CallingWindowIgnored\": false,\n \"NotEnoughTimeToComplete\": false,\n \"TextMessage\": null,\n \"DeliveredTexts\": 0,\n \"NotDeliveredTexts\": 0,\n \"InvalidTextCount\": 0,\n \"FailedTextTotal\": 0,\n \"TextReplies\": 0,\n \"UnreadTextReplies\": 0,\n \"UnreadConversationReplies\": 0,\n \"NotRepliedTotal\": 0,\n \"TextOptedOut\": 0,\n \"TextNumberID\": null,\n \"TextPhoneNumber\": null,\n \"TextBroadcastID\": 10006260\n}\n\nPlease call GET /v1/broadcast/{BroadcastID} for full details of a broadcast.
| Property | Description |
|---|---|
| string Uri | This is the path to high level information about the broadcast just created. |
| string UriBroadcastDetails | This is the path to details of the broadcast, including the call and/or text results as they complete. |
| integer BroadcastID | The unique identifier for the created broadcast. |
| string BroadcastName | The name of the broadcast. |
| broadcast-typeBroadcastType | The type of the broadcast. |
| broadcast-status-categoryBroadcastStatus | The status of the broadcast. |
| broadcast-status-categoryBroadcastStatusCategory | The category the broadcast status belongs to. |
| date-timeCreatedDate | The broadcast creation time. |
| date-timeStartDate | The Broadcast start time. |
| date-timeCompletedDate | The broadcast's completion time. |
| phone-numberCallerID | The phone number the voice call is initiated from. [Will be null for text type broadcasts.] |
| float CreditsUsed | The number of credits the broadcast used. |
| integer PhoneNumberCount | The count of the phone numbers in the broadcast. |
| integer TotalCompleted | These are delivered messages, undeliverable messages and opted out contacts. Canceled or expired contacts do not count. |
| userUser | The user that created the broadcast. [To get the full user details call GET /v1/account/users] |
| transfer-and-connectTransferAndConnect | The settings for transfer and connect broadcasts. [Null otherwise.] |
| audioAudio | The assigned audio message for voice broadcasts. [Will appear for voice type broadcasts only.] |
| audioAudioVM | The assigned audio message for survey and transfer and connect broadcasts to be played when voicemail is reached. [Will appear for voice type broadcasts only.] |
| integer RetryTimes | The number of times a call is retried after busy signal or no answer. [Will appear for voice type broadcasts only.] |
| integer CallThrottle | The call speed specifies the number of simultaneous calls that can be ongoing at any given time. [Will appear for voice type broadcasts only.] |
| integer LivePersonTotal | The total number of calls that reached a live person. [Will appear for voice type broadcasts only.] |
| integer AnsweringMachineTotal | The total number of calls that reached voicemail. [Will appear for voice type broadcasts only.] |
| integer BusyNoAnswerTotal | The total number of calls that were not answered. [Will appear for voice type broadcasts only.] |
| integer InvalidNumberTotal | The total number of calls that were opted out or unreachable. [Will appear for voice type broadcasts only.] |
| integer SurveyResponseTotal | The total number of calls that responded to the survey question. [Will appear for voice type broadcasts only.] |
| integer TransferTotal | The total number of calls that elected to transfer. [Will appear for voice type broadcasts only.] |
| broadcast-survey-responseBroadcastSurveyResponse | The number of times each digit selected to the survey question. [Will appear for voice type broadcasts only.] |
| integer MaxMessageLength | The maximum number of seconds the audio message can be. [Will appear for voice type broadcasts only.] |
| message-recording-instructionMessageRecordingInstruction | Instructions for how to record the audio message for the broadcast if audio was not provided. [Will appear for voice type broadcasts only.] |
| integer EstimatedDuration | The number of minutes the broadcast completion is estimated to take. [Will appear for voice type broadcasts only.] |
| integer EstimatedCompletion | The date the broadcast is estimated to complete by. [Will appear for voice type broadcasts only.] |
| boolean ExcludedDaysIgnored | Whether the user's settings of the default days to limit making calls on should be ignored. [Will appear for voice type broadcasts only.] |
| boolean CallingWindowIgnored | Whether the user's settings of the default calling window should be ignored. [Will appear for voice type broadcasts only.] |
| boolean NotEnoughTimeToComplete | Whether it is estimated that the calls would not be able complete inside the calling window. [Will appear for voice type broadcasts only.] |
| string TextMessage | The text of the text message. [Will appear for text type broadcasts only.] |
| integer DeliveredTexts | The count of contacts the text message was successfully sent to. [Will appear for text type broadcasts only.] |
| integer NotDeliveredTexts | The count of contacts the text message was failed to sent. [Will appear for text type broadcasts only.] |
| integer InvalidTextCount | The count of the text broadcast's phone numbers that were invalid. [Will appear for text type broadcasts only.] |
| integer FailedTextTotal | The number of messages that failed in a text broadcast. [Will appear for text type broadcasts only.] |
| integer TextReplies | The number of replies received to a text broadcast. [Will appear for text type broadcasts only.] |
| integer UnreadTextReplies | The number of replies not yet marked as read. [Will appear for text type broadcasts only.] |
| integer UnreadConversationReplies | The number of unread conversation replies. [Will appear for text type broadcasts only.] |
| integer NotRepliedTotal | The number of recipients who have not yet replied to a text broadcast. [Will appear for text type broadcasts only.] |
| integer TextOptedOut | The number of contacts opted out after receiving the text broadcast. [Will appear for text type broadcasts only.] |
| integer TextNumberID | The resource ID for the text number used in the text broadcast. [Will appear for text type broadcasts only.] |
| string TextPhoneNumber | The toll free number or local number the text broadcast was sent from. [Will appear for text type broadcasts only.] |
| string TextBroadcastID | Creating a combo broadcast results in creating two separate broadcasts. The response from the call populates both the CallBroadcastID and TextBroadcastID fields. |
| failed-contactsFailedContacts | The contacts that were not included in the broadcast created. [Will appear only in the response for a create-broadcast.] |
{\n \"UriCallBroadcast\": \"/v1/broadcasts/39609\",\n \"PhoneNumber\": \"2145555055\",\n \"NumberOfAttempts\": 1,\n \"LastCallTime\": \"2017-05-25 17:54:53-0500\",\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Notes\": null,\n \"IntegrationData\": \"A67CH829\",\n \"SurveyResult\": null,\n \"CallResultCategory\": \"Live Answer\",\n \"CallStatus\": \"Completed\",\n \"TransferDuration\": 0,\n \"TransferCredits\": 0.0,\n \"IsTransferInitiated\": false,\n}| Property | \nDescription | \n
|---|---|
| string UriCallBroadcast | \nThe link to the broadcast. | \n
| phone-number PhoneNumber | \nThe contacted phone number. | \n
| integer NumberOfAttempts | \nThe number of attempts made to contact the number. | \n
| datetime LastCallTime | \nThe last attempt to contact the number. | \n
| string FirstName | \nThe recipient's first name. | \n
| string LastName | \nThe recipient's last name. | \n
| string Notes | \nThe recipient's notes field. Maximum length is 50 characters. | \n
| string IntegrationData | \nData field for a 3rd party integration ID. Maximum length is 512 characters. | \n
| string SurveyResult | \nThe survey response the called party responded with. [Survey only] | \n
| call-result CallResult | \nThe detailed result of the call attempt made. [Voice Call only] | \n
| call-result-category CallResultCategory | \nThe higher level result of the call attempt made. [Voice Call only] | \n
| call-status CallStatus | \nThe status of the call. [Voice Call only] | \n
| call-result TransferResult | \nIf the recipient opted to transfer, this would contain the call result of the transferred call. [Voice Transfer & Connect Call only] | \n
| integer TransferDuration | \nThe number of seconds on a transfer the two parties remained on the line. [Voice Transfer & Connect Call only] | \n
| float TransferCredits | \nThe number of credits the transfer portion of the call used. [Voice Transfer & Connect Call only] | \n
| boolean IsTransferInitiated | \nWhether the called party initiated a transfer by pressing STAR ZERO. [Voice Transfer & Connect Call only] | \n
| string TextMessage | \nThe text message sent to the contact. This message would only be different from the broadcast's TextMessage if the broadcast was using customized fields from the contact (e.g. \"Hi {{FirstName}}!\"). [Text only] | \n
| text-status TextStatus | \nThe status of the text. [Text only] | \n
| text-result TextResult | \nThe detailed result of a text message attempt. [Text only] | \n
| text-result-category TextResultCategory | \nThe high level result of a text message attempt. [Text only] | \n
| array text-response TextResponses | \nA list of text responses to your broadcast. [Text only] | \n
| boolean HasMedia | \nIs true if the outbound message contained media. [Text only] | \n
Recipients can respond to a survey broadcast by pressing * followed by a single number 0-9. Responses to a survey broadcast will be formatted like the example in this model.
{\n \"BroadcastSurveyResponse\": {\n \"_1\": 14,\n \"_2\": 10,\n \"_3\": 0,\n \"_4\": 0,\n \"_5\": 0,\n \"_6\": 0,\n \"_7\": 0,\n \"_8\": 0,\n \"_9\": 0,\n \"_0\": 0\n }\n}| Property | \nDescription | \n
|---|---|
| integer _1 | \nThe number of *1 responses to the survey question. | \n
| integer _2 | \nThe number of *2 responses to the survey question. | \n
| integer _3 | \nThe number of *3 responses to the survey question. | \n
| integer _4 | \nThe number of *4 responses to the survey question. | \n
| integer _5 | \nThe number of *5 responses to the survey question. | \n
| integer _6 | \nThe number of *6 responses to the survey question. | \n
| integer _7 | \nThe number of *7 responses to the survey question. | \n
| integer _8 | \nThe number of *8 responses to the survey question. | \n
| integer _9 | \nThe number of *9 responses to the survey question. | \n
| integer _0 | \nThe number of *0 responses to the survey question. | \n
A contact is a person included in a broadcast or saved to the Contacts section of your Text-Em-All account.
\n{\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"PrimaryPhone\": \"2145551212\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"Away in December!\",\n \"PersonID\": 4912484,\n \"DoNotCallPrimaryPhone\": false,\n \"DoNotCallSecondaryPhone\": false,\n \"DoNotCallTertiaryPhone\": false,\n \"PrimaryPhoneTextOptInStatus\": \"\",\n \"SecondaryPhoneTextOptInStatus\": \"\",\n \"TertiaryPhoneTextOptInStatus\": \"\",\n \"LastUpdated\": \"2018-11-08 17:54:13.153-0600\",\n \"Lists\": \n [\n {\n \"ListID\": 3,\n \"ListType\": \"User\",\n \"ListName\": \"Test\",\n \"ListDescription\": \"\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2018-09-27 13:57:38.323-0500\",\n \"RosterCount\": 25000,\n },\n {\n \"ListID\": 5,\n \"ListType\": \"User\",\n \"ListName\": \"From broadcast\",\n \"ListDescription\": \"Uploaded from broadcast\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2018-08-20 14:32:49.217-0500\",\n \"RosterCount\": 0,\n }\n ]\n}\n\n| Property | Description |
|---|---|
| integer PersonID | The contact resource's unique identifier. |
| string FirstName | The contact's first name (optional). |
| string LastName | The contact's last name (optional). |
| phone-number PrimaryPhone | The primary phone number (required). |
| phone-number SecondaryPhone | An optional secondary phone number. |
| phone-number TertiaryPhone | An optional tertiary phone number. |
| string Notes | An optional note for the contact. Maximum length is 50 characters. |
| boolean DoNotCallPrimaryPhone | Whether the primary phone number is on the do not call list. |
| opt-in-status PrimaryPhoneTextOptInStatus | The text opt-in status for the primary phone number. |
| boolean DoNotCallSecondaryPhone | Whether the secondary phone number is on the do not call list. |
| opt-in-status SecondaryPhoneTextOptInStatus | The text opt-in status for the secondary phone number. |
| boolean DoNotCallTertiaryPhone | Whether the tertiary phone number is on the do not call list |
| opt-in-status TertiaryPhoneTextOptInStatus | The text opt-in status for the tertiary phone number. |
| datetime LastUpdated | The last time the contact was changed. |
| array List Lists | The list of groups the contact is a member of (optional). |
A conversation between one of your text numbers and a contact or recipient.
\n{\n \"ConversationID\": 11111,\n \"TextNumberID\": 22222,\n \"PhoneNumber\": \"2145550678\",\n \"UnreadCount\": 0,\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"Notes\": \"This note will show up in your Text-Em-All account\",\n \"IntegrationData\": \"{'OriginId':'241490','Msg':'IntegrationData will show when you GET a conversation via the API'}\",\n \"OptedOut\": false,\n \"OptedIn\": false\n}| Property | \nDescription | \n
|---|---|
| integer ConversationID | \nThe unique resource ID for the conversation model. | \n
| integer TextNumberID | \nThe resource ID for the text number used in the conversation. | \n
| string PhoneNumber | \nThe phone number contacted. | \n
| integer UnreadCount | \nThe count of unread inbound messages from the recipient/contact. | \n
| string FirstName | \nThe first name of the contact. [Maximum length is 50 characters] | \n
| string LastName | \nThe last name of the contact. [Maximum length is 50 characters] | \n
| string Notes | \nThe notes field of the contact. [Maximum length is 50 characters] | \n
| string IntegrationData | \nData field for a 3rd party integration ID. [Maximum length is 512 characters] | \n
| boolean OptedOut | \nWill return true if the contact's number is opted out. | \n
| boolean OptedIn | \nA recipient would need to text \"join\" to one of your text numbers in order to opt in. | \n
This model contains data needed to single sign in a user to a broadcast they created via /draftbroadcasts.
{\n \"DraftBroadcastID\": 221611,\n \"Created\": \"2014-04-25 15:47:26-0500\",\n \"SingleSignOnToken\": \"2c683f59-a797-4de1-8868-b8e172720342\",\n \"SingleSignOnUrl\": \"https://staging-app.call-em-all.com/sso.aspx?TemporaryKey=2c683f59-a797-4de1-8868-b8e172720342\",\n \"FailedContacts\": \n [\n {\n \"ErrorCode\": 203,\n \"ErrorMessage\": \"Duplicate phone number: 2141111920\",\n \"Contact\": \n {\n \"FirstName\": \"Mary\",\n \"LastName\": \"Gibson\",\n \"PrimaryPhone\": \"2141111920\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"\",\n \"IntegrationData\": \"A56CJ829\",\n }\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| long DraftBroadcastID | \nUnique identifier of the draft broadcast just created. | \n
| date-time Created | \nThe draft broadcast creation time. | \n
| string SingleSignOnUrl | \nYour application will be able to open up the Text-Em-All website in a new browser window or iframe with this URL. | \n
| string SingleSignOnToken | \nThe unique temporary token used to single sign on a user. This token is used in the SingleSignOnUrl as a query parameter. | \n
| array draft-broadcast-contact FailedContacts | \nInformation about why some (if any) contacts failed and which (if any) contacts failed. | \n
An individual contact included in a draft broadcast.
\n{\n \"FirstName\": \"John\",\n \"LastName\": \"Doe\",\n \"PrimaryPhone\": \"2145551212\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"Away in December!\",\n \"IntegrationData\": \"A56CJ829\"\n}| Property | \nDescription | \n
|---|---|
| string FirstName | \nThe contact's first name (optional). | \n
| string LastName | \nThe contact's last name (optional). | \n
| phone-number PrimaryPhone | \nThe primary phone number (required). | \n
| phone-number SecondaryPhone | \nAn optional secondary phone number. | \n
| phone-number TertiaryPhone | \nAn optional tertiary phone number. | \n
| string Notes | \nAn optional note for the contact. Maximum length is 50 characters. | \n
| string IntegrationData | \nData we will store on the contact record for a specific broadcast when the broadcast is created. This can be data that will help you link up the contact in your application/database at a later time (optional). | \n
Helps us link data in your file to common terms.
\n{\n \"Tabs\": \n [\n {\n \"Name\": \"Sheet1\",\n \"HasHeaderRow\": false,\n \"RowNumber\": 3,\n \"ColumnNumber\": 4,\n \"TotalContactCount\": 3,\n \"Phone1\": 0,\n \"Phone2\": null,\n \"Phone3\": null,\n \"FirstName\": 1,\n \"LastName\": 2,\n \"Notes\": 3,\n \"Rows\": \n [\n [\n \"9725551000\",\n \"Fred\",\n \"Jones\",\n \"Note1\"\n ],\n [\n \"9725551001\",\n \"Mike\",\n \"Smith\",\n \"Note2\"\n ],\n [\n \"9725551002\",\n \"Mary\",\n \"Doe\",\n \"\"\n ]\n ],\n \"AreaCode1\": null,\n \"AreaCode2\": null,\n \"AreaCode3\": null,\n \"ListID\": null,\n \"ListName\": null,\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| string Name | \nThe name of the data sheet. | \n
| boolean HasHeaderRow | \nWhether the first row contains headers. | \n
| integer RowNumber | \nThe number of rows on the data sheet. | \n
| integer ColumnNumber | \nThe number of columns on the data sheet. | \n
| integer TotalContactCount | \nThe total number of contacts found on the data sheet. | \n
| integer Phone1 | \nThe column index that contains the Primary Phone information. Zero based. | \n
| integer Phone2 | \nThe column index that contains the Secondary Phone information. Zero based. Null if there is no such column. | \n
| integer Phone3 | \nThe column index that contains the Tertiary Phone information. Zero based. Null if there is no such column. | \n
| integer FirstName | \nThe column index that contains the First Name information. Zero based. Null if there is no such column. | \n
| integer LastName | \nThe column index that contains the Last Name information. Zero based. Null if there is no such column. | \n
| integer Notes | \nThe column index that contains the Notes information. Zero based. Null if there is no such column. | \n
| array Rows | \nA sample of the first few data rows. | \n
| integer AreaCode1 | \nThe column index that contains the area code of the Primary Phone information. Only needed if the Phone1 column does not have the area code included in the number. Zero based. Null if there is no such column. | \n
| integer AreaCode2 | \nThe column index that contains the area code of the Secondary Phone information. Only needed if the Phone2 column does not have the area code included in the number. Zero based. Null if there is no such column. | \n
| integer AreaCode3 | \nThe column index that contains the area code of the Tertiary Phone information. Only needed if the Phone3 column does not have the area code included in the number. Zero based. Null if there is no such column. | \n
| integer ListID | \nThe column index that contains the List ID information. Zero based. Null if there is no such column. | \n
| integer ListName | \nThe column index that contains the List Name information. Zero based. Null if there is no such column. | \n
Helps us link data in your file to common terms.
\n{\n \"TabCount\": 1,\n \"Tabs\": \n [\n {\n \"Name\": \"Sheet1\",\n \"HasHeaderRow\": false,\n \"RowNumber\": 3,\n \"ColumnNumber\": 4,\n \"TotalContactCount\": 3,\n \"Phone1\": 0,\n \"Phone2\": null,\n \"Phone3\": null,\n \"FirstName\": 1,\n \"LastName\": 2,\n \"Notes\": 3,\n \"Rows\": \n [\n [\n \"9725551000\",\n \"Fred\",\n \"Jones\",\n \"Note1\"\n ],\n [\n \"9725551001\",\n \"Mike\",\n \"Smith\",\n \"Note2\"\n ],\n [\n \"9725551002\",\n \"Mary\",\n \"Doe\",\n \"\"\n ]\n ],\n \"AreaCode1\": null,\n \"AreaCode2\": null,\n \"AreaCode3\": null,\n \"ListID\": null,\n \"ListName\": null,\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| integer TabCount | \nThe number of data sheets the file has. | \n
| array file-tab Tabs | \nThe file's data sheets. | \n
The results and details of a file upload.
\n{\n \"Summary\": \n {\n \"GoodRecordCount\": 16,\n \"BadRecordCount\": 0,\n \"DuplicateRecordCount\": 0,\n \"GoodFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/goodrecords\",\n \"BadFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/badrecords\",\n \"DuplicateFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/duplicaterecords\",\n \"ConflictedRecordCount\": 0,\n \"GoodContactCount\": 16,\n }\n}| Property | \nDescription | \n
|---|---|
| integer GoodRecordCount | \nThe number of records in the file upload that are in correct format. | \n
| integer BadRecordCount | \nThe number of records in the file that cannot be used to create a contact out of. For example it is missing the phone number or the phone number is 9 digits. | \n
| integer DuplicateRecordCount | \nThe number of records that are in a correct format, but the phone number is already listed in the same file upload. | \n
| string GoodFeedUri | \nThe link to the feed that pages through the correct file upload records. | \n
| string BadFeedUri | \nThe link to the feed that pages through the incorrect file upload records. | \n
| string DuplicateFeedUri | \nThe link to the feed that pages through the duplicate file upload records. | \n
| integer ConflictedRecordCount | \nThe number of records containing the same phone numbers that are already stored in contacts. | \n
| integer GoodContactCount | \nOne file upload record can contain up to three phone numbers. The GoodContactCount will give the number of good contacts in the file upload. | \n
The file upload model can be included in a broadcast or when adding contacts to be stored in your Text-Em-All contacts.
\n{\n \"FileID\": \"73312_20181109141519.csv\",\n \"Status\": \"Completed\",\n \"Created\": \"2018-11-09 14:15:19.598-0600\",\n \"FileStructure\": null,\n \"Summary\": \n {\n \"GoodRecordCount\": 16,\n \"BadRecordCount\": 0,\n \"DuplicateRecordCount\": 0,\n \"GoodFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/goodrecords\",\n \"BadFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/badrecords\",\n \"DuplicateFeedUri\": \"/v1/fileuploads/73312_20181109141519.csv/duplicaterecords\",\n \"ConflictedRecordCount\": 0,\n \"GoodContactCount\": 16,\n }\n}| Property | \nDescription | \n
|---|---|
| string FileID | \nThe unique resource ID for the file upload. | \n
| file-upload-status Status | \nThe file upload status. | \n
| datetime Created | \nThe time the file upload was initiated. | \n
| file-structure FileStructure | \nThe perceived structure of the file. | \n
| summary Summary | \nThe summary result of the file upload. | \n
This model tracks the progress of uploading a file to a group or broadcast.
\n{\n \"Status\": \"Complete\",\n \"Total\": 4,\n \"Completed\": 4\n}| Property | \nDescription | \n
|---|---|
| file-upload-status Status | \nThe file upload status. | \n
| integer Total | \nThe total number of records in the upload. [Includes good records, bad records, and duplicates] | \n
| integer Completed | \nThe number of successful records which have been processed. | \n
Contacts that failed to be added to a draft broadcast.
\n{\n \"FailedContacts\": \n [\n {\n \"ErrorCode\": 203,\n \"ErrorMessage\": \"Duplicate phone number: 2141111920\",\n \"Contact\": \n {\n \"FirstName\": \"Mary\",\n \"LastName\": \"Gibson\",\n \"PrimaryPhone\": \"2141111920\",\n \"SecondaryPhone\": \"\",\n \"TertiaryPhone\": \"\",\n \"Notes\": \"\",\n \"IntegrationData\": \"A56CJ829\",\n }\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| error-code ErrorCode | \nThe code that describes why this contact failed. | \n
| string ErrorMessage | \nDetailed message about the error. | \n
| draft-broadcast-contact Contact | \nDetailed information about the contact that failed. | \n
Text-Em-All allows larger organizations to have multiple accounts. These are accounts are connected by a shared group code. A group code opt out is a recipient who has opted out of messages; either voice, text or both on all accounts of a group code.
\n{\n \"GroupCode\": \"home\",\n \"PhoneNumber\": \"9725556591\",\n \"DoNotCall\": false,\n \"DoNotText\": true\n}\n\n| Property | Description |
|---|---|
string GroupCode | The name of the group code. |
phone-number PhoneNumber | The opted out phone number. |
boolean DoNotCall | True if the phone number is opted out of voice messages, false otherwise. |
boolean DoNotText | True if the phone number is opted out of text messages, false otherwise. |
{\n \"SetupCompleted\": true,\n \"UserID\": 111111,\n \"AuthToken\": \"00000000-0000-0000-0000-000000000000\",\n \"OnboardingCompleted\": true,\n \"InvalidLogin\": false,\n \"WebHooks\": [\n {\n \"ID\": 5595,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n },\n \"Type\": \"TextOutbound\",\n \"Method\": \"Webhook\",\n \"NotificationMethodData\": null\n }\n ],\n \"TextNumbers\": [\n {\n \"TextNumberID\": 11111,\n \"TextPhoneNumber\": \"18335555555\",\n \"Name\": null,\n \"Description\": null,\n \"UnreadCount\": 0,\n \"IsDefault\": false,\n \"IsBlocked\": false,\n \"FlatRateConversation\": false,\n \"FlatRateConversationStatus\": \"Inactive\",\n \"FlatRateSubscriptionEndDate\": null,\n \"TextNumberSpeed\": null\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| boolean SetupCompleted | \nThis value will return false if the user has not completed onboarding or if they have no text numbers assigned to them. | \n
| long UserID | \nUnique identifier for the user. | \n
| guid AuthToken | \nAuthtoken for the user; used to make all future REST calls to Text-Em-All. | \n
| boolean OnboardingCompleted | \nOnboarding is a sequence of steps to complete before the user can start sending messages. If this returns false, the user should login and complete all onboarding steps. | \n
| boolean InvalidLogin | \nWill return true if FailIfUserSetupNotCompleted was set to true (when calling POST /singlesignon/setup) and OnboardingCompleted returns false or TextNumbers is an empty array. | \n
| array webhook WebHooks | \nAn array of webhook notifications the user is subscribed to receive. | \n
| array text-number TextNumbers | \nA list of text numbers assigned to this user. | \n
This contains information about a group saved in your Text-Em-All account.
\n{\n \"ListID\": 5,\n \"ListType\": \"User\",\n \"ListName\": \"Parents\",\n \"ListDescription\": \"Uploaded from broadcast\",\n \"SMSName\": \"\",\n \"IsAutoReplyOn\": false,\n \"AutoReplyMessage\": \"\",\n \"LastUpdated\": \"2018-11-09 13:51:44.5-0600\",\n \"RosterCount\": 1,\n}| Property | \nDescription | \n
|---|---|
| integer ListID | \nThe unique resource ID for the contact group. | \n
| list-type ListType | \nThe type of the contact group. | \n
| string ListName | \nA short name of the contact group. | \n
| string ListDescription | \nA longer description of the contact group. | \n
| boolean SMSName | \nWhen an SMSName is assigned to the contact group, people can opt in directly to the group by texting \"join SMSName\" to the short code. | \n
| boolean IsAutoReplyOn | \nWhen the flag is set to true on the group the AutoReplyMessage will be sent as an automatic reply to all phone numbers opting in to the group. | \n
| string AutoReplyMessage | \nThis is the auto reply message sent to a phone number opting in to the group when the IsAutoReplyOn flag is set to true on the contact group. | \n
| string LastUpdated | \nThe last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group. | \n
| integer RosterCount | \nThe contact group's membership count. | \n
Provides a way for an audio message to be recorded when audio was not provided for a broadcast.
\n{\n \"MessageRecordingInstruction\": {\n \"Uri\": \"/v1/broadcasts/58439/recording-instructions\",\n \"PhoneNumber\": \"866.284.4401\",\n \"MessageRecordingID\": \"134535\",\n \"Status\": \"RecordingComplete\",\n }\n}| Property | \nDescription | \n
|---|---|
| string Uri | \nThe link to self. | \n
| string PhoneNumber | \nThe toll free number to call to record the voice message. | \n
| string MessageRecordingID | \nEnter this code when the toll free script prompts for the recording ID. | \n
| audio-recording-status Status | \nThe recording status. | \n
{\n \"ID\": 5593,\n \"IsActive\": true,\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n }\n}| Property | \nDescription | \n
|---|---|
| long ID | \nUnique identifier for the webhook notification. | \n
| boolean IsActive | \nBoolean to show if the webhook notification is active or not. | \n
| notification-window NotificationWindow | \nDescribes the days, and hours on those days, notifications will be sent. | \n
The response model of a notification.
\n{\n \"NotificationWindow\": {\n \"Days\": [\n \"Sunday\",\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\",\n \"Saturday\"\n ],\n \"StartTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n },\n \"StopTimeOfDay\": {\n \"Hour\": 0,\n \"Minute\": 0\n }\n }\n}| Property | \nDescription | \n
|---|---|
| array string Days | \nDay of the week. | \n
| time-of-day StartTimeOfDay | \nNotifications will only be sent in the hours between the StartTimeOfDay and StopTimeOfDay. This field is the time of day the notification window should start. | \n
| time-of-day StopTimeOfDay | \nNotifications will only be sent in the hours between the StartTimeOfDay and StopTimeOfDay. This field is the time of day the notification window should end. | \n
A Do Not Call is a recipient who has opted out of your messages; either voice, text or both.
\n{\n \"FirstName\": \"John\",\n \"LastName\": \"Smith\",\n \"PhoneNumber\": \"9725556591\",\n \"Notes\": \"Employee Number 1234\",\n \"OptoutDate\": \"2021-06-02 09:42:10-0500\",\n \"DoNotCall\": false,\n \"DoNotText\": true,\n \"GlobalOptOut\": false,\n \"TextOptOutMethod\": \"WebAppOptOut\",\n \"VoiceOptOutMethod\": \"Opt Out via {{your-integration-name}}\"\n }\n\n| Property | Description |
|---|---|
string FirstName | The opt out's first name. |
string LastName | The opt out's last name. |
phone-number PhoneNumber | The opted out phone number. |
string Notes | If the recipient was a contact with notes, they will show here. |
datetime OptoutDate | The datetime the contact opted out. |
boolean DoNotCall | True if the phone number is opted out of voice messages, false otherwise. |
boolean DoNotText | True if the phone number is opted out of text messages, false otherwise. |
boolean GlobalOptOut | True if the phone number is opted out of voice and text messages across all Text-Em-All accounts, false otherwise. |
string TextOptOutMethod | The method used to opt the recipient out of text messages. |
string VoiceOptOutMethod | The method used to opt the recipient out of voice messages. |
When you post to /singlesignon/conversations you will receive back link which allows you to open a iframe or browser window with a copy of Text-Em-All's conversation thread for a phone number. You can pass in these optional values to enable some of the action icons.
{\n \"Customization\": {\n \"AuthorizationChangeEnabled\": true,\n \"EditEnabled\": false,\n \"MarkAsDoneEnabled\": false\n }\n}| Property | \nDescription | \n
|---|---|
| boolean AuthorizationChangeEnabled | \nEnabling this icon will allow a user to change the text opt out status of a phone number. [Defaults to true] | \n
| boolean EditEnabled | \nEnabling this icon will allow a user to edit the FirstName, LastName and Notes of a conversation. [Defaults to true] | \n
| boolean MarkAsDoneEnabled | \nEnabling this icon will allow the user to move this conversation to Text-Em-All's \"Done\" folder. This could cause issues if you are always expecting this conversation to show when GET /conversations/single?textphonenumber=...&phonenumber=... [Defaults to false] | \n
A template merge progress describes the result of applying custom data to a draft broadcast's base template text.
\n{\n \"ID\": 637774933011405543,\n \"UserID\": 12345,\n \"Status\": \"Complete\",\n \"Message\": \"Applying template merge completed.\",\n \"Total\": 52,\n \"Completed\": 52\n}| Property | \nDescription | \n
|---|---|
| string ID | \nThe unique ID of the template merge progress | \n
| long UserID | \nThe user submitting the request | \n
| string Status | \nComplete / Error | \n
| string Message | \nStatus description | \n
| integer Total | \nThe total number of records to be merged. | \n
| integer Completed | \nThe number of records succesfuly merged. | \n
{\n \"TextMessageID\": 1223957,\n \"CreateTimestamp\": \"2021-05-26 16:10:08-0500\",\n \"IsInbound\": false,\n \"Message\": \"Hello Jason, this is Text-Em-All Staffing. Are you available for work today (5/27)?\",\n \"Type\": \"Chat\",\n \"State\": \"Sent To Aggregator\",\n \"Mms\": [\n {\n \"ID\": 964,\n \"Extension\": \"jpg\",\n \"FileName\": \"IMG_6344.jpg\",\n \"CeaUrlOriginal\": \"https://dqqtyujvpgldg1.cloudfront.net/eiols00w0ek0_1903529750957_O_IMG_6344.jpg\",\n \"CeaUrlPreview\": \"https://dqqtyujvpgldg1.cloudfront.net/cpoge0-2kfsh_1903529750957_P_IMG_6344.jpg\"\n }\n ],\n \"HasMedia\": true,\n \"PhoneNumber\": \"5055553399\",\n \"TextNumberID\": 22222,\n \"UriForUser\": \"/users/11111\",\n \"UriForBroadcast\": \"/v1/broadcasts/10001111\"\n}\n\n| Property | Description |
|---|---|
| integer TextMessageID | The unique identifier of the text message. |
| datetime CreateTimestamp | The time the message was received/sent. |
| boolean IsInbound | True if the message was sent into Text-Em-All from the contact/recipient. |
| string Message | The text message that was sent/received. |
| type Type | The type of the message. |
| text-result-category State | The result of the message. |
| textmms-data Mms | If the message contains media, this will contain the details of that media. |
| boolean HasMedia | True if the message contains media. |
| phone-number PhoneNumber | The phone number of the contact/recipient. |
| string TextNumberID | The ID of the Text-Em-All text number communicating with the recipient/contact. |
| string UriForUser | Uri to link the user that sent a message. [Will be null for inbound messages that are not a Broadcast Reply] |
| string UriForBroadcast | Uri to link the broadcast that sent the message or was replied to. [Will be null if the messages was not related to a broadcast] |
| text-delivery-receipt DeliveryReceipt | Delivery receipt for the text mnessage sent. Not populated if it is not requested to be included. |
{\n \"TextMessageID\": 1223957,\n \"SendStatusID\": 1,\n \"DeliveryStatusID\": 1,\n \"DeliverySuccess\": \"true\",\n \"DeliveryResult\": \"Status: DELIVERED_TO_HANDSET Message delivered to handset Error: NO_ERROR No Error\",\n \"SendStatus\": \"Sent To Carrier\",\n \"DeliveryStatus\": \"Delivered\"\n}\n\n| Property | Description |
|---|---|
| integer TextMessageID | The unique identifier of the text message. |
| delivery-receipt-send SendStatusID | Numeric value representing the sending status of the text message. |
| delivery-receipt-delivery DeliveryStatusID | Numeric value representing the status of the text message delivery. Not set if a delivery receipt has not been received. |
| string DeliverySuccess | Whether the text message has been succesfully delivered. Can be \"true\", \"false\" or \"unknown\". |
| string DeliveryResult | More detailed description of the delivery receipt. Not set if a delivery status has not been received. |
| delivery-receipt-send SendStatus | A string representing the sending status of the text message. The long form description of SendStatusID. |
| delivery-receipt-delivery DeliveryStatus | A string value representing the status of the text message delivery. The long form description of DeliveryStatusID. |
{\n \"Mms\": [\n {\n \"ID\": 964,\n \"Extension\": \"jpg\",\n \"FileName\": \"IMG_6344.jpg\",\n \"CeaUrlOriginal\": \"https://d3qkbrjvpe8d55.cloudfront.net/eif380n3o9n0_1602688001957_O_IMG_6344.jpg?Expires=2147418848&Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kM3FrYnJqdnBlOGQ1NS5jbG91ZGZyb250Lm5ldC9laWYzODBuM285bjBfMTYwMjY4ODAwMTk1N19PX0lNR182MzQ0LmpwZyIsIkNvbmRpdGlvbiI6eyJEYXRlTGVzc1RoYW4iOnsiQVdTOkVwb2NoVGltZSI6MjE0NzQxODg0OH19fV19&Signature=URRHvlKOp3PydNnr6FO-Ma2mPyDi5wfJgCP3m575wHoca0C7ayIBYU6UBz3A7kRQ4mGa89FQSmJW1HcBCRLg3vOAUn~sWuNqNnckgcMD4nQGdmjM5rsJGer~6yy8ZouD7-4PeIFghROELfDEIS~FHUTP06Y-SAYhXcIEipiM0hpGw09zko5-UpL~GSpNy3ckirt39Pfv5UueQkhNQEMD3oCppE8XIWdiQ~j5xiBZhovduawhvh3tjaflFxs1m~I0RTluZQ9QQOA~6c1tpu2w5rpXDKcG7XJ-X22rnOOdVGY8VV5uFHRx6mwvxFRMkTMg2e4ULdVTLbR6UgWkoJb5MA__&Key-Pair-Id=APKAJDPNXLHUCKXHKSCQ\",\n \"CeaUrlPreview\": \"https://d3qkbrjvpe8d55.cloudfront.net/cq0uuxsgpldh_1602688001957_P_IMG_6344.jpg?Expires=2147418848&Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kM3FrYnJqdnBlOGQ1NS5jbG91ZGZyb250Lm5ldC9jcTB1dXhzZ3BsZGhfMTYwMjY4ODAwMTk1N19QX0lNR182MzQ0LmpwZyIsIkNvbmRpdGlvbiI6eyJEYXRlTGVzc1RoYW4iOnsiQVdTOkVwb2NoVGltZSI6MjE0NzQxODg0OH19fV19&Signature=RAnqMbZWIXUGMlM~VCgrWEXol~LQGYbbZuEq7GMAjUu-fdAiX3h6fZ-LBAkxYgUb~JOnjkiTW6hrUORbcotbBsdxBV3lDjwCxrcRjqwlstxdYmS20q4ckfNdz2Oz1ea7Ni6FO2H-ZhYUlL~fcOsHyqK-TiLrXqJaQhAhX7yqKcZpIYK7iNxT68X2~qSRuD2s1KzqOcUF8tqwj31FeL53OYlcinb3BSsf7scVZacZZX68khRjs0yWAiUQxuJIIiD4EKvqX-1kMJPfHQ5LdwOkOG2ZIKwA0RNsRdR2hI7SAwXJXs1joywUDqwG-JU39owWNNI1swyXihulzzjNtfFPqA__&Key-Pair-Id=APKAJDPNXLHUCKXHKSCQ\"\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| integer ID | \nThe unique identifier of the MMS Data. | \n
| string Extension | \nThe file type extension. | \n
| string FileName | \nThe name of the MMS file uploaded. | \n
| string CeaUrlOriginal | \nOriginal size link to the image. | \n
| string CeaUrlPreview | \nSmaller size link to the image. | \n
{\n \"TextNumberID\": 11111,\n \"TextPhoneNumber\": \"18335555555\",\n \"Name\": null,\n \"Description\": null,\n \"UnreadCount\": 0,\n \"IsDefault\": false,\n \"IsBlocked\": false,\n \"FlatRateConversation\": false,\n \"FlatRateConversationStatus\": \"Inactive\",\n \"FlatRateSubscriptionEndDate\": null,\n \"TextNumberSpeed\": null\n }| Property | \nDescription | \n
|---|---|
| long TextNumberID | \nUnique identifier for the text number. | \n
| string TextPhoneNumber | \nThe phone number your messages will come from. | \n
| string Name | \nAn optional name for the text number [50 characters max]. | \n
| string Description | \nAn optional description for the text number [200 characters max]. | \n
| integer UnreadCount | \nThe count of unread messages for this text number. | \n
| boolean IsDefault | \nIf a user has multiple text numbers, this field will only return true for the default text number. | \n
| boolean IsBlocked | \nText numbers can sometimes get blocked by carriers for different reasons. If your number is blocked, please contact our support team for assistance getting your number unblocked. | \n
| boolean FlatRateConversation | \nReturns true if the text number is enabled for unlimited conversations. | \n
| unlimited-text-number-status FlatRateConversationStatus | \nThe status only matters if FlatRateConversation is true. This property shows the current status of the unlimited text number. | \n
| datetime FlatRateSubscriptionEndDate | \nThis property only matters if FlatRateConversation is true. On this date we will attempt to renew your unlimited conversation subscription. | \n
| string TextNumberSpeed | \nThe text speed setting for this text number. | \n
Provides information about a text response to a text type broadcast.
\n{\n \"TextResponses\": [\n {\n \"ReceivedAt\": \"2020-10-29 17:09:28.33-0500\",\n \"Subject\": null,\n \"Body\": \"Got it\",\n \"Type\": \"Broadcast Reply\",\n \"Status\": null,\n \"PhoneNumber\": \"5052053399\",\n \"Notes\": \"ID 123456\",\n \"BroadcastId\": 10006312,\n \"TextResponseId\": 614541,\n \"FirstName\": \"Jack\",\n \"LastName\": \"Black\",\n \"IsRead\": false,\n \"Media\": null\n }\n ]\n}| Property | \nDescription | \n
|---|---|
| datetime ReceivedAt | \nThe time the message was received. | \n
| string Body | \nThe text message body. | \n
| type Type | \nThe type of message received. | \n
| phone-number PhoneNumber | \nThe phone number that sent the reply. | \n
| string Notes | \nAn optional note for the contact. [Maximum length is 50 characters.] | \n
| integer BroadcastId | \nThe reply is attributed to the BroadcastID listed here. | \n
| integer TextResponseId | \nThe unique id for this reply. | \n
| string FirstName | \nThe contact's first name. [Optional] | \n
| string LastName | \nThe contact's last name. [Optional] | \n
| boolean IsRead | \nTrue if the reply has been viewed. | \n
| textmms-data TextMmsData | \nIf the message contains media, this will contain the details of that media. | \n
Provides information about a text template stored in the message library.
\n{\n \"TextResponses\": [\n {\n \"TemplateID\": 537,\n \"TemplateName\": \"Reply\",\n \"TemplateText\": \"This is a shared reply.\",\n \"TemplateType\": \"ConversationReply\",\n \"Created\": \"2019-01-07T14:00:07.73\",\n \"ReadOnly\": false,\n \"IsShared\": false,\n \"IsFavorite\": true,\n \"IsActive\": true,\n \"HasCustomField\": false\n }\n ]\n}\n\n| Property | Description |
|---|---|
| number TemplateID | The unique identifier of the text template. |
| string TemplateName | The name of the text template. |
| string TemplateText | The text content of the template. |
| template-type TemplateType | The type of the text template. |
| datetime Created | The time the text template was created. |
| boolean ReadOnly | Whether the text template can be modified or deleted. |
| boolean IsShared | Whether the text template is shared across multiple Text-Em-All accounts. |
| boolean IsFavorite | Whether the text template is marked with a Star as favorite. |
| boolean IsActive | Whether the text template is active or deleted. |
| boolean HasCustomField | Whether the text template's text includes personalization. E.g. \"Hi {FirstName}!\", becoming \"Hi Joe!\" when personalized information is applied from the contacts. |
The model describes a time of the day. For example 9:00 or 20:00.
\n{\n \"Hour\": 8,\n \"Minute\": 30,\n}| Property | \nDescription | \n
|---|---|
| integer Hour | \nThe hours part of the time of day. 0..23 | \n
| integer Minute | \nThe minutes part of the time of day. 0..59 | \n
Transfer & Connect allows a recipient of a voice call to press 0 to be connected to a phone number of your choice. Click here to see information about how to set up Transfer & Connect on your account.
\n{\n \"IsTransfer\": true,\n \"TransferLines\": 1,\n \"TransferNumber\": \"2142998560\",\n \"TransferCreditsUsed\": 1.0\n}| Property | \nDescription | \n
|---|---|
| boolean IsTransfer | \nWhether the broadcast was, or should be, set up for transfer and connect. | \n
| integer TransferLines | \nThe limit of transfer lines. The broadcast will not make more calls at the same time to ensure that if all calls opt to transfer there are enough resources on your side to answer all of them. | \n
| string TransferNumber | \nThe phone number the calls are transferred to upon request. | \n
| float TransferCreditsUsed | \nThe sum of all credits used for the call transfers. When a transfer is connected it costs one credit per minute while the caller stays on the line. | \n
An object describing the properties and settings of an account user.
\n| Property | \nDescription | \n
|---|---|
| string FirstName | \nThe user's first name. | \n
| string LastName | \nThe user's last name. | \n
| email Email | \nThe user's email address. | \n
| phone-number Phone | \nThe user's phone number. | \n
| string State | \nAn abbreviated two letter state. | \n
| boolean isAccountAdmin | \nWill be true if the user is an account administrator, otherwise false. | \n
| boolean isMasterUser | \nWill be true if the user is the highest level of admin user, otherwise false. | \n
| phone-number CallerID | \nThe phone number displayed on the recipient's caller ID. | \n
| permissions Permissions | \nUser permissions. | \n
| password PinCode | \nThe login password. | \n
| username Username | \nThe login username. | \n
| guid AuthToken | \nThe users Auth Token. [Will only be returned on user creation or when you call POST /user/login] | \n
User permissions. Specifying whether the user has access to all audio, contacts and broadcasts on the account.
\n{\n \"CanSeeAllBroadcasts\": true,\n \"CanSeeAllRoster\": true,\n \"CanSeeAllAudio\": true,\n \"CanSeeGroupAudio\": false,\n}| Property | \nDescription | \n
|---|---|
| boolean CanSeeAllBroadcasts | \nWhether the user can have access to all broadcasts on the account that other users created. | \n
| boolean CanSeeAllRoster | \nTrue if the user has permission to see/message contacts on the account; including contacts that other users created. | \n
| boolean CanSeeAllAudio | \nTrue if the user has access to see/use audio on the account; including audio that other users created. | \n
| boolean CanSeeGroupAudio | \nTrue if user has access to the group audio. Group audio is audio from the audio library that is shared across accounts of the same company. | \n
{\n \"Type\": \"BroadcastStatusChange\",\n \"Url\": \"https://mysite.com/mywebhook\",\n \"Authorization\": \"Basic c2Rmc2RmOnNkZnNkZg==\"\n}| Property | \nDescription | \n
|---|---|
| string Url | \nUrl where the webhook notifications will be sent. | \n
| string Authorization | \nIf authentication is required when posting to the provided url, an authorization header value can be used in ths property. [optional] | \n
| notification-type Type | \nThe type of webhook notification. | \n
The list of objects that can be passed in the request payload or received in the response.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"c547c456-de45-4be7-a66d-88b11d36f7c7"},{"name":"Common Types","item":[{"name":"Audio Recording Status","item":[],"id":"6eb8218d-e33c-4e19-ab66-6a57e9b0da09","description":"The possible statuses that an audio recording can take.
\n{\n \"Status\": \"AwaitingRecording\"\n}| Type | \nDescription | \n
|---|---|
| AwaitingRecording | \nThe audio has not been recorded yet. It is waiting for the user to record the message. | \n
| RecordingComplete | \nThe audio recording has been completed. | \n
When calling GET /audio you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/audio?page=1&pagesize=10&takesize=10&sortby=lastused| Type | \nDescription | \n
|---|---|
| added | \nThe datetime the audio was added. | \n
| lastused | \nThe datetime the audio was last used. | \n
| name | \nThe name of the audio. | \n
| type | \nThe audio type. | \n
| Type | \nDescription | \n
|---|---|
| NeverUsed | \nAudio that has never been used on a broadcast. | \n
| Announcement | \nA standard voice message. | \n
| SurveyLiveAnswer | \nA survey type message intended for a recipient who answers live. | \n
| SurveyVoiceMail | \nA survey type message intended for a call that goes to the recipient's voicemail | \n
| AnnouncementVoiceMail | \nA message used for voicemail | \n
| TransferAndConnect | \nA transfer type message intended for a call that goes to the recipient's voicemail | \n
When calling GET /broadcasts you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/broadcasts?sortby=startdate| Type | \nDescription | \n
|---|---|
| callbroadcastid | \nUnique identifier of a broadcast. | \n
| name | \nThe broadcast name. | \n
| createddate | \nThe date the broadcast was created. | \n
| startdate | \nThe date the broadcast started or will start. | \n
| broadcasttype | \nThe type of broadcast. | \n
| broadcaststatus | \nThe status of the broadcast. | \n
| totalcompleted | \nThe total number of completed calls in the broadcast. | \n
| phonenumbercount | \nTotal number of phone numbers included in the broadcast. | \n
When calling GET /broadcasts/{{BroadcastID}}/details you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/broadcasts/{{BroadcastID}}/details?page=1&takesize=10&sortby=lastcalltime| Type | \nDescription | \n
|---|---|
| lastcalltime | \nThe last datetime the contact was messaged by Text-Em-All for this broadcast. | \n
| nextcalltime | \nThe next datetime the contact will be messaged by Text-Em-All for this broadcast | \n
| firstname | \nSorts by the first name of the recipient. | \n
| lastname | \nSorts by the last name of the recipient. | \n
| phonenumber | \nSorts by the recipient's phone number. | \n
| Notes | \nSorts by recipient's notes. | \n
| numberofattempts | \nSorts by how many attempts a text or call took to complete. | \n
| callresult | \nSorts a voice broadcast by the Call Result. | \n
| textresult | \nSorts a text broadcast by the Text Result. | \n
| callstatus | \nSorts a voice broadcast by the Call Status. | \n
| textstatus | \nSorts a text broadcast by the Text Status. | \n
| surveyresult | \nSorts results by the broadcast survey response. | \n
| transferduration | \nSorts a live transfer broadcast by the transfer duration (how long the transferred recipient spent on the transferred portion of the call). | \n
| transfercredits | \nSorts a live transfer broadcast by the number of transfer credits used (If a call is transferred, 1 credit = 1 minute of connection time). | \n
| transferresult | \nSorts a live transfer broadcast by the transfer result (same as a call result but for the transfer portion of the call). | \n
Throughout its lifetime from creation to completion the broadcast goes through a series of statuses. These statuses are more granual than you might care for. We have created a grouping of these statuses into categories that has the right granularity to follow the actual state change of a broadcast.
\n{\n \"BroadcastStatusCategory\": Scheduled\n}| Type | \nDescription | \n
|---|---|
| NeedsMessage | \nIf a call broadcast was created without a message it stays in NeedsMessage status until a message is recorded or added; or the broadcast expires without a message being added. | \n
| Expired | \nIf a call broadcast was created without an audio it is kept in NeedsMessage status for a week after its scheduled start date. If there is still not a message added to the broadcast after that, the broadcast gets archived in an Expired status. | \n
| Processing | \nAfter a text broadcast is created or after a call broadcast is created with an audio or after the audio is added to a broadcast in NeedsMessage status, there is a short period while the broadcast is getting set up. During this time the broadcast is in Processing status. | \n
| Rejected | \nIf during the processing of the broadcast there was some kind of an issue the broadcast moves into a Rejected status. It could be because of bad audio quality of a voice message or the message violating our Terms of Use. Broadcasts in rejected statuses will not be sent out and cannot be edited. | \n
| Scheduled | \nWhen a broadcast is all set up and just waiting for the StartTime to pass (to start sending messages) it is in this status. | \n
| Broadcasting | \nA broadcast is in Broadcasting status while the messages are being sent out. | \n
| Completed | \nA broadcast moves to a final Completed status, after Broadcasting, when all the messages have been sent out or the broadcast was canceled. | \n
When calling GET /textresponses you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/textresponses?broadcastid=10009225&received~gt~2021-01-01| Type | \nDescription | \n
|---|---|
| textresponseid | \nThe unique identifier of the text reply. | \n
| received | \nThe datetime the reply was received. | \n
| broadcastid | \nThe ID of the broadcast the reply is being attributed to. | \n
| phonenumber | \nThe phone number that replied. | \n
Broadcast type must be passed in when creating a broadcast so that we know the type of broadcast you wish to create. This type will be returned in the response or when calling a GET /broadcasts.
{\n \"BroadcastType\": Announcement\n}| Type | \nDescription | \n
|---|---|
| Announcement | \nIt is a simple voice broadcast that plays an audio message to the phone numbers contacted. For example: Hi, This is Jane Doe reminding you that our scheduled meeting has been moved to Tuesday... | \n
| Survey | \nThe survey is a type of broadcast that plays a message prompting the contact to press STAR and a response digit 1, 2, 3 etc.. to convey a choice. For example, Hi, This is Jane Doe. If you can attend our next meeting on Tuesday please press *1, if you are unable to attend please press *2... | \n
| SMS | \nSMS is a text broadcast type that sends a text message to the broadcast's recipients. | \n
| SMSAndAnnouncement | \nBroadcast type for creating a combination broadcast. Each recipient will receive both a voice and a text message. | \n
| SMSAndSurvey | \nBroadcast type for creating a combination broadcast. Each recipient will receive both a survey and a text message. | \n
| SMSOrAnnouncement | \nBroadcast type for creating a combination broadcast. The textable phone numbers will receive a text message, while the remaining numbers receive a voice message. | \n
| SMSOrSurvey | \nBroadcast type for creating a combination broadcast. The textable phone numbers will receive a text message, while the remaining numbers receive a voice survey message. | \n
The detailed result of a phone call attempt.
\n{\n \"CallResult\": \"Live Person\"\n}| Type | \nDescription | \n
|---|---|
| Live Person | \nThe call has been initiated to the phone number and someone picked up the phone. | \n
| Voice Mail | \nThe call has been initiated to the phone number and a message was left on an answering machine. | \n
| Busy | \nThe dial to the phone number encountered a busy signal without anyone answering or being sent to vociemail. | \n
| Do Not Call | \nThe number either opted out of the current broadcast or was opted out when the broadcast started. | \n
| No Answer | \nThe call was not answered by a live person or an answering machine. | \n
| Invalid Number | \nThe number is not reachable as it is likely disconnected or no longer in service. | \n
| No Result | \nThe phone number has not yet been, or was not, called. | \n
| Calling Window Expired | \nThe phone number was not called because the broadcast calling window expired. | \n
| Canceled | \nThe phone number was not called because the broadcast was cancelled before we could attempt this call. | \n
| Call Failed | \nThis is a grouped category of several outlier reasons a call might fail when sent through the network. | \n
| Message Rejected | \nThe phone number was not called because your message was rejected. | \n
| Hang Up During Transfer | \nThis result will only appear for Transfer & Connect type calls where the recipient hangs up while the call is in the process of being transferred. | \n
| Voice Mail Full | \nFor this result an answering machine was reached. However, a voicemail could not be recorded because we received an error message stating the mailbox was full. | \n
| Voice Mail Not Set Up | \nFor this result an answering machine was reached. However, a voicemail could not be recorded because we received an error message stating the mailbox was net yet set up. | \n
The high level result of a phone call attempt.
\n{\n \"CallResultCategory\": \"LiveAnswer\"\n}| Type | \nDescription | \n
|---|---|
| LiveAnswer | \nThe call has been initiated to the phone number and someone picked up the phone. | \n
| Voicemail | \nThe call has been initiated to the phone number and a message was left on an answering machine. | \n
| BusyNa | \nThe dial to the phone number encountered a busy signal without anyone answering or being sent to vociemail. | \n
| Invalid | \nThis was not a valid phone number to call or the number has opted out. | \n
| NotCompleted | \nThe call was not completed. It could be because the broadcast was rejected, canceled or the contact was on the do not call list. | \n
The status of a phone call attempt.
\n{\n \"CallStatus\": \"CallCompleted\"\n}| Type | \nDescription | \n
|---|---|
| NotCalled | \nThe phone number in the broadcast has not been called yet. | \n
| Calling | \nThe call is being placed to the phone numnber at this time. | \n
| CallCompleted | \nThe intended call to the phone number is in a completed status. Depending in the call result this could mean that the message has been successfully delivered or that the broadcast has been canceled before the call has been made, or that the call was not attempted because the phone number was on the do not call list. | \n
When calling GET /lists you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/lists?page=1&pagesize=10&q=ee&sortby=lastupdated| Type | \nDescription | \n
|---|---|
| lastupdated | \nThe last datetime the list was updated by a user | \n
| name | \nSorts by the name of the list. | \n
When calling GET /contacts you can use sortby as a query param with one of the following sort options.
https://staging-rest.call-em-all.com/v1/contacts?pagesize=5&page=2&include=lists&sortby=lastnamefirstname&sortby=firstnamelastname| Type | \nDescription | \n
|---|---|
| lastcalltime | \nThe last datetime the contact was messaged by Text-Em-All | \n
| firstnamelastname | \nSorts by first name first, and then last name second. | \n
| lastnamefirstname | \nSorts by last name first, and then first name second. | \n
| phonenumber | \nSorts by the contact's phone number. | \n
| Notes | \nSorts by contact's notes. | \n
The different type of credit events that can adjust a Pay As You Go account's balance of credits.
\n{\n \"CreditTypeDescription\": \"TextBroadcast\"\n}| Type | \nDescription | \n
|---|---|
| AutoRefill | \nAdding credits to the account via auto refill by credit card. | \n
| AutoReply | \nAuto reply message using up credits. | \n
| Conversation | \nConversation message using up credits. | \n
| FreeTrial | \nInitial account balance of free trial credits. | \n
| ManualEntry | \nManual adjustment to account credit balance. | \n
| MMSConversation | \nMMS conversation message using up credits. | \n
| MMSTextBroadcast | \nMMS text broadcast using up credits. | \n
| Purchase | \nAdding credits to the account via purchase. | \n
| Referral | \nCredits awarded to the account for client referral. | \n
| Refund | \nCredits added back to the account for errors, mistakes, outages. | \n
| TextBroadcast | \nText broadcast using up credits. | \n
| TextMessageForwarding | \nShort code texting auto forward using up credits. | \n
| VoiceBroadcast | \nVoice broadcast using up credits. | \n
Can be passed in as a query param or passed in as an endpoint property. The property is a string and should be used in the following format: 2/1/2020 1:15PM
The time zone corresponds to the setting you have in your account. This can be viewed by visiting https://app.text-em-all.com/settings/profile
A valid email address. The string must conform to the following regular expression: \\A(?:[a-z0-9!#$%&'+/=?^_{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_{|}~-]+)@(?:a-z0-9?.)+a-z0-9?)\\Z
{\n \"ErrorCode\": 203\n}| Code | \nDescription | \n
|---|---|
| -1 | \nUnknown | \n
| 0 | \nOk | \n
| 1 | \nInternal | \n
| 100 | \nAuthentication Failed | \n
| 101 | \nAccess Not Granted | \n
| 102 | \nCannot Undo | \n
| 103 | \nInvalid Version | \n
| 104 | \nNot Found | \n
| 105 | \nNot Fully Onboarded | \n
| 106 | \nToken Expired | \n
| 200 | \nInvalid Parameter Keyword | \n
| 201 | \nInvalid Parameter Value | \n
| 202 | \nInvalid Empty Parameter | \n
| 203 | \nDuplicate Parameter Value | \n
| 204 | \nUnsupported Input Format | \n
| 205 | \nInput Too Large | \n
| 3000 | \nBroadcast Not Allowed | \n
| 3001 | \nCreate Broadcast Failed | \n
| 3002 | \nCancel Broadcast Failed | \n
| 3003 | \nUpdate Broadcast Failed | \n
| 3004 | \nPreview Broadcast Failed | \n
| 5000 | \nKeyword Opt-In Failed | \n
| 5001 | \nPhone Number Opted-Out | \n
When calling GET /fileuploads/{{file_name}}/{{record_type}} you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1//fileuploads/{{file_name}}/goodrecords?page=1&pagesize=10&q=214&sortby=linenumber| Type | \nDescription | \n
|---|---|
| linenumber | \nThe line number of the file you uploaded. | \n
| errormessage | \nSorts by the error message of the uploaded contacts. | \n
| firstname | \nSorts by contact's first name. | \n
| lastname | \nSorts by contact's last name. | \n
| phonenumber | \nSorts by the contact's phone number. | \n
| Notes | \nSorts by contact's notes. | \n
The status of a file upload progress.
\n{\n \"Status\": InProgress\n}| Status | \nDescription | \n
|---|---|
| InProgress | \nIf a file upload is processed in an asynchronous way, the file upload request will return immediately with an InProgress status. Socket events will communicate the progress and the final result of the file upload. | \n
| Complete | \nThe file upload has successfully completed. | \n
| Error | \nThere was an error during the file upload process. | \n
List Type is a property on the List model.
\n{\n \"ListType\": System\n}| Type | \nDescription | \n
|---|---|
| System | \nThe predefined contact lists: Everyone, Unfiled, Deleted - have a System list type. | \n
| User | \nAll other contact lists created by users or created via the API have a User list type. | \n
Describes how you wish to receive notifications.
\n{\n \"Method\": \"Webhook\"\n}| Type | \nDescription | \n
|---|---|
| Webhook | \nNotifications will be sent to a URL of your choosing. | \n
| Notifications will be sent to the email address on file. | \n|
| Text | \nNotifications will be sent to your phone number on file. | \n
The types of notifications you can sign up to receive when you call POST /singlesignon/setup.
{\n \"Type\": \"BroadcastStatusChange\"\n}| Type | \nDescription | \n
|---|---|
| BroadcastStatusChange | \nThroughout its lifetime from creation to completion the broadcast goes through a serious of statuses (created, broadcasting, completed, etc.). This notification fires when a broadcast changes from one status to another. | \n
| TextInbound | \nThis notification fires when someone send a message to one of your text numbers. | \n
| TextOutbound | \nThis notification is fired when an outbound message is sent out from one of your text numbers. | \n
| TextUnread | \nThis notification will be sent in the time period and method of your choosing. | \n
| ContactAuthorizationChange | \nThis event will be triggered if one of your contact's opt in/out status changes. | \n
The opt in/out status of a phone number.
\n{\n \"PrimaryPhoneTextOptInStatus\": OptedOut\n}| Type | \nDescription | \n
|---|---|
| NoAuthRecordFound | \nThere is no opt-in or opt-out information associated with this phone number. | \n
| OptedOut | \nThis phone number has opted-out of receiving text messages. | \n
| SMSInviteSent | \nThere has been an opt-in invitation sent to the phone number, but no reply has been received yet. | \n
| AuthorizationAccepted | \nThis phone number has opted-in to receive text messages. An inbound text message was sent from the phone giving consent for messages to be sent. | \n
When calling GET /optouts you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/optouts?optout-status=voice&sortby=-dateadded| Type | \nDescription | \n
|---|---|
| dateadded | \nThe most recent datetime the recipient opted out of voice or text messages. | \n
| phonenumber | \nThe opted out phone number. [The number could be opted out of voice, text or both] | \n
A PhoneNumber is a sequence of ten digits representing a telephone number. The phone number can contain digits, space, hyphens, parenthesis or dots in the standard format of a phone number. The number must adhere to the North American Numbering Plan (NANP). NANP uses NPA-NXX-xxxx telephone number format where NPA is a 3-digit area code, NXX is a 3-digit central exchange code, and xxxx is the subscriber number. The NPANXX format disallows some values for certain digits. Text-Em-All screens each number to make sure it adheres to the NANP. Phone numbers are also checked see if they are capable of receiving texts.
\n","_postman_id":"94774d61-dbd4-4af4-9550-22738e3083c2","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","name":"Common Types","type":"folder"}}},{"name":"PIN / Password","item":[],"id":"774c5354-1da7-4bce-9648-02b099594ffd","description":"In combination with a Username, the Personal Identification Number (PIN) authenticates a Text-Em-All account. The PIN has undergone some changes from its original format and might be more accurately considered to be a password. In fact, the Text-Em-All website refers to PINs as Passwords. Historically, the PIN was a 4-digit to 10-digit numeric string. In November of 2014, the PIN format was expanded to allow alphanumeric characters and symbols. Legacy PINs are still supported and there is no requirement to switch to the new format. A PIN must be 8-25 characters long, must contain at least one digit and at least one letter, and can't have any whitespace characters. Special symbols are allowed. To be exact, a PIN must conform to the following regular expression: ^(?=.\\d)(?=.[a-zA-Z])(?!.*\\s).{8,25}$/.
\n","_postman_id":"774c5354-1da7-4bce-9648-02b099594ffd","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","name":"Common Types","type":"folder"}}},{"name":"Text Delivery Receipt Delivery Status","item":[],"id":"dbcd1f0c-f911-4dc7-80f1-f6703f132db5","description":"The status of the text message delivery to the recipient's phone.
\n{\n \"DeliveryStatusID\": 1,\n \"DeliveryStatus\": \"Delivered\"\n}\n\n| ID | Status | Description |
|---|---|---|
| null | Missing | There was no delivery receipt received. |
| 1 | Delivered | The message has been successfully delivered to the recipient's phone. |
| 2 | Failed | The message has failed to deliver to the recipient's phone. |
| 3 | Rejected | The message has been rejected by the carriers. |
| 4 | Undeliverable | The message could not be delivered to the recipient's phone. |
| 5 | Expired | The attempt to deliver the message to the recipient's phone has expired. |
| 6 | Unknown | The delivery receipt received is unknown. |
| 7 | Enroute | Delivery receipt indicating that the message is still on the way to the recipient's phone. |
| 8 | Accepted | The message has been accepted by the recipient's phone. |
| 9 | Not Billable Failure | The message has failed to deliver to the recipient's phone. There will be no charge for the attempt. |
The status of sending the text message.
\n{\n \"SendStatusID\": 1,\n \"SendStatus\": \"Sent To Carrier\"\n}\n\n| ID | Status | Description |
|---|---|---|
| 0 | Needs Sending | The message has not been sent yet. |
| 1 | Sent To Carrier | The message has been successfully sent to the carriers. Check the delivery status for receipt. |
| 2 | Carrier Rejected | The message was rejected by the recipient's carrier. |
| 3 | Canceled | The message send has been canceled before the message was sent. |
| 4 | Opted Out | The message has not been sent, because the recipient has opted out prior. |
| 5 | Attempts Exceeded | The message send failed because the number of attempts to deliver the message to the aggregator have exceeded the limit. |
| 6 | Blacklisted | The message send failed because the text number that the message was set up to be sent is blacklisted. |
| 7 | Sent To Carrier | After a retry, the message has been successfully sent to the carriers. Check the delivery status for receipt. |
| 8 | Message Rejected | The message has not been sent, because of its content. |
| 9 | Imported | The message was not sent by Text-Em-All, but rather an other provider. The message was imported to Text-Em-All for users to have historical context. |
How we classify different types of inbound/outbound text messages.
\n{\n \"Type\": \"Broadcast Reply\"\n}| Type | \nDescription | \n
|---|---|
| Broadcast | \nAn outbound broadcast message to a phone number. | \n
| Stop | \nThe recipient replied with the word \"stop\" to opt-out of your text messages. | \n
| Opt Out Confirmation | \nIf a recipient opted-out of your messages, we send a confirmation message with this message type. | \n
| Unstop | \nhe recipient replied with the word \"unstop\" to opt back in to your text messages. | \n
| Unstop Confirmation | \nIf a recipient opts back in to your messages, we send a confirmation message with this message type. | \n
| Broadcast Reply | \nThe message is being attributed as a reply to a specific broadcast. | \n
| Chat | \nAn inbound or outbound message to a conversation. [IsInbound in the response can be used to determine the direction.] | \n
| Join Everyone | \nThe contact sent in the word \"join\" to one of your text numbers. | \n
| Join Group | \nThe contact sent in \"join {Group Name}\" to one of your text numbers. | \n
| Join Confirmation | \nIf a recipient sends in the word \"join\" (with or without a group name) we send a confirmation message with this message type. | \n
| Broadcast Launch | \nThis type will only appear for phone numbers who have access to send messages from your Text-Em-All account using the phone launch feature. | \n
| Bc Launch Confirmation | \nIf a user launches a broadcast, using the phone launch feature, we send a confirmation message with this message type. | \n
| Bc Launch Error | \nIf there is an error using the phone launch feature, we send a error message with this message type. | \n
| Auto Opt Out | \nWe use machine learning to help figure out if the recipient was attempting to opt-out, but did not use the word \"stop\" to do so (e.g. \"don't text me anymore\"). If we determine the recipient was attempting to opt out, we flag the message with this type and opt them out of receiving messages from your account. | \n
| Group Sms | \nThe message was sent as a group conversation message from your Text-Em-All account (similar to a broadcast). | \n
When calling GET /textnumbers you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/textnumbers?page=1&pagesize=10&q=833&sortby=name&status=3| Type | \nDescription | \n
|---|---|
| name | \nSorts by the text number's name. | \n
| textnumber | \nSorts by the text phone number. | \n
| status | \nSorts by the text number's status. | \n
| description | \nSorts by the text number's description. | \n
| lastupdated | \nSorts by datetime the text number was last updated. | \n
| flatrateconversationstatus | \nSorts by the text number's unlimited text number status. | \n
| flatratesubscriptionenddate | \nSorts by the text number's unlimited subscription end date. | \n
| namethentextnumber | \nSorts by the text number's name first, then by the text phone number second. | \n
| defaultthenunlimited | \nSorts by the text number's default value first, then the text number's unlimited status second. | \n
The status of a text number.
\n{\n \"TextStatus\": \"Active\"\n}\n\n| Type | Description |
|---|---|
Active | The text number is active for your account. |
Retired | This will be that status for text numbers which used to belong to your account but no longer are. |
Requested | If you brought your own text number, this will be the status until the textability of the number is added to our text aggregators. |
Denied | If you brought your own text number, this could be the status if the moving the textability of the number to our aggregator fails. |
The result of a text message sent to a phone number. We are now returning the actual result of the carrier delivery receipt in order to be more transparent about the result of the text message. In the case we do not receive a carrier delivery receipt, you will receive one of the responses below.
\n{\n \"TextResult\": \"Needs Sending\"\n}| Type | \nDescription | \n
|---|---|
| Needs Sending | \nThe text message has not yet been sent. | \n
| Sent To Carrier | \nThe text message was sent to the carrier of the recipient and the carrier has not yet updated us with a delivery receipt. | \n
| Carrier Rejected | \nThe recipient's carrier rejected the message. | \n
| Canceled | \nThe message was unsent because the broadcast was cancelled. | \n
| Opted Out | \nThe message was unsent because the recipient was opted-out when the broadcast started. | \n
| Attempts Exceeded | \nThe message was not successful because too many message attempts have been sent to this phone number. | \n
| Blacklisted | \nThe number is currently on the carrier blacklist. This can happen when a recipient cancels their service with a carrier. | \n
| Message Rejected | \nThe message was rejected by the aggregator or carrier. | \n
The high level result of a text message sent to a phone number.
\n{\n \"TextResultCategory\": \"Not Sent\"\n}| Type | \nDescription | \n
|---|---|
| Sent | \nThe text message was successfully sent to the carrier. | \n
| Not Sent | \nThe text message has not yet been sent or the broadcast has been canceled. | \n
| Delivered | \nThe text message was successfully sent to the carrier and we have received a confirmation about the carrier delivering the message to the phone. | \n
| Invalid | \nThe phone number was invalid and the text message could not be sent to the phone. | \n
| Opted Out | \nThe text message was not sent because the phone number has opted out of receiving text messages. | \n
The status of a text message attempt.
\n{\n \"TextStatus\": \"Not Complete\"\n}| Type | \nDescription | \n
|---|---|
| Not Complete | \nThe text message has not yet been sent out. | \n
| Completed | \nThe text message send has completed or there was no reason to send the message. This could be because the broadcast has been canceled or the phone number has opted out of receiving text messages. | \n
The types of text templates available to store in the message library.
\n{\n \"TemplateType\": \"Text\"\n}\n| Type | Description |
|---|---|
| ConversationReply | The type of text template that can be sent out via the Text-Em-All Conversations page. |
| Text | The type of text template that can be used in text broadcasts. |
When calling GET /templates you can use sortby as a query parameter with one of the following sort options.
{{base_url}}/v1/templates?sortby=name\n| Type | Description |
|---|---|
| name | The name of the text template. |
| text | The full text content of the text template. |
| createdby | The user's name who created the text template. |
| createddate | The date when the text template was created. |
{\n \"Audio\": {\n \"TextToSpeech\": true,\n \"Text\": \"This text will become audio.\",\n \"Voice\": \"Salli\"\n }\n}| Name | \nGender | \nNeural Voice | \nStandard Voice | \nIs Default | \n
|---|---|---|---|---|
| Ivy | \nFemale (child) | \nYes | \nYes | \nNo | \n
| Joanna | \nFemale | \nYes | \nYes | \nYes | \n
| Kendra | \nFemale | \nYes | \nYes | \nNo | \n
| Kimberly | \nFemale | \nYes | \nYes | \nNo | \n
| Salli | \nFemale | \nYes | \nYes | \nNo | \n
| Joey | \nMale | \nYes | \nYes | \nNo | \n
| Justin | \nMale (child) | \nYes | \nYes | \nNo | \n
| Kevin | \nMale (child) | \nYes | \nNo | \nNo | \n
| Matthew | \nMale | \nYes | \nYes | \nNo | \n
A text number enabled for unlimited conversations will be in one of these statuses. If the number is not enabled for unlimited conversations, the status means nothing.
\n{\n \"FlatRateConversationStatus\": \"Inactive\"\n}| Status | \nDescription | \n
|---|---|
| Inactive | \nUnlimited conversations is not currently active for this text number. | \n
| Active | \nUnlimited conversations is active for the text number. | \n
| CancelPending | \nThe text number is currently active but will be cancelled at the end of the current cycle. | \n
| BillingProblem | \nWhen attempting to renew unlimited conversations on the text number we were not able to charge the credit card on file. | \n
When calling GET /account/users you can use sortby as a query param with one of the following sort options.
{{base_url}}/v1/account/users?sortby=firstnamelastname| Type | \nDescription | \n
|---|---|
| username | \nThe username of the user. | \n
| firstnamelastname | \nSorts by first name first, and then last name second. | \n
| lastnamefirstname | \nSorts by last name first, and then first name second. | \n
| lastaccess | \nSorts by the user who most recently accessed their account. | \n
| active | \nSorts by users who are active. | \n
The Username is a unique identifier used to log in to an account. Historically, Username was a sequence of five to ten digits. In November of 2014, we began allowing alphanumeric characters and some symbols. Legacy Usernames are still supported and there is no requirement to update to the new format. New or updated Usernames must be 8-50 characters long and can consist of letters, numbers, and the following special characters: . _ ~ ! @ # $ % ^ & * - / + ' and ?. To be exact, Usernames must conform to this regular expression: ^(?=.{8,50}$)[a-zA-Z0-9._~!@#$%^&*-/+'?]+$.
\n","_postman_id":"df83ee15-68e2-4a0e-ad73-aca0b0592fe8","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","name":"Common Types","type":"folder"}}}],"id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e","description":"The Rest API request and response models' properties rely on a number of data types and special data formats. We've collected them here for your convenience. When an API request or response model property references a common type, you'll see a link to the common type in the Property column.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"472a7bcc-e12f-4bfa-bff0-7edbaa2b0bfa","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9a5995c3-0e79-4ddb-8f8a-69ded2e9991a","type":"text/javascript","exec":[""]}}],"_postman_id":"6130e2d3-0a77-413a-9ca2-aaeeea83c17e"}],"auth":{"type":"oauth1","oauth1":{"token":"{{access_token}}","consumerSecret":"{{consumer_secret}}","consumerKey":"{{consumer_key}}","signatureMethod":"