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":"5105759","collectionId":"8a5d2863-b893-4341-a516-7425792d2ea1","publishedId":"T1Dtfbfv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-07-31T08:02:08.000Z"},"item":[{"name":"Setup","item":[],"id":"38d08c9f-91c2-4605-a892-7e2a46ec07a1","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 Call-Em-All you need to do the following:
\nWhen a new Call-Em-All account is created, an account owner user is also created. Additional users can be created manually after logging in to an account, or programmatically via the API. Each user has a unique authentication token for your integration that you will need to connect to the user in your system. You will need to pass that token in order for your API requests to authenticate the user.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1f53212d-512f-4b29-aa81-411c33509736","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b8774b2a-ac50-4313-a254-910473cb3ed6","type":"text/javascript","exec":[""]}}],"_postman_id":"38d08c9f-91c2-4605-a892-7e2a46ec07a1"},{"name":"API Basics","item":[{"name":"API Requests","item":[],"id":"5e9715eb-efba-482d-a09d-3adc88c61aa9","description":"The base URL for all endpoints start with: https://rest.call-em-all.com/v1\nOur test environment’s base URL is: https://staging-rest.call-em-all.com/v1
\nThe API endpoints can only be accessed through HTTPS. All requests via HTTP will result in an error, returning status code 403 - Forbidden.\nThe currently supported format is JSON. In all requests please set the Accept and Content-Type headers to application/json.
\nHeaders\n{\n \"Accept\": \"application/json\",\n \"Content-Type\": \"application/json\",\n \"Content-Length\": ...,\n ....\n}The API uses standard OAuth version 1 for authentication. You will receive an AppKey and a SecretKey from Call-Em-All upon requesting API access for your application. You will need to create an OAuth signature created from these keys along with your Call-Em-All user’s authorization token. Add the signature in the Authorization header in all of your requests. Requests without a valid signature will return a response status code of 401 – Unauthorized.
\nHeaders\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.
\nOn unsuccessful requests along with the return code the response body may contains the following Error resource model:
\n{\n \"ErrorCode\": 200,\n \"ErrorType\": \"Informational\",\n \"Message\": \"CreateDate cannot be used as a search parameter.\",\n}You can use search and sort parameters for API endpoints that return a collection of resources. Please refer to the documentation of each endpoint for fields that you can use in your search.
\nSeparate your search criteria with the ’&’ sign. In each search criteria have the field name on the left and constant value on the right.
\nThe following operators are available. (Please refer to the documentation of each endpoint to see which operators are valid).
\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,-CreateDateCollections are returned in the format of a feed - in a paged format. A feed is an object that contains resources in a set size of array, also a URL for the next and previous set of data and the total number of resources available in the collection. You can use query parameters to define how many records a page returned should contain. The default is always 10.
\n| page={p} | \nThe page number. | \n
| pagesize={n} | \nThe number of items a page has. | \n
| takesize={t} | \nHow many items to return. Optional. Equal to pagesize if omitted. | \n
/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 avoid flooding of requests, our API limits the frequency in which you can access each endpoint. Your request will receive a status code 503 – Service Unavailable, in response when reaching an excessive limit. Please contact api@call-em-all.com if you are concerned about the request rate for your endpoints used.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"ccf72a8c-c203-4926-afd2-9f3cefbd343f"}],"id":"5bfbc688-6b01-4f01-a486-256dbaa0d8d3","auth":{"type":"noauth","isInherited":false},"_postman_id":"5bfbc688-6b01-4f01-a486-256dbaa0d8d3","description":""},{"name":"API Functions","item":[{"name":"Account","item":[{"name":"Get Account Settings","id":"5ee5b57e-5fdc-4952-9f17-0f49da843a57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth1","oauth1":{"token":"{{auth_token}}","consumerKey":"{{app_key}}","consumerSecret":"{{secret_key}}","signatureMethod":"The Response contains the following properties:
\n\n| Property | \nDescription | \n
|---|---|
| long AccountID | \nThe account's unique identifier. | \n
| string Address1 | \nThe first line of the billing address for the company. | \n
| string Address2 | \nThe second line of the billing address for the company. | \n
| decimal AvailableCallUnits | \nFor 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. | \n
| decimal CallBalance | \nFor credit accounts. The number of call units (credits) the account has. The balance will be reduced when a broadcast completes. | \n
| string City | \nThe billing address's city. | \n
| string CompanyName | \nThe billing company name. | \n
| integer MessengerCount | \nThe number of additional users created on the account. | \n
| decimal MonthlyFee | \nFor subscription accounts. The monthly subscription fee. | \n
| integer MonthlyLevel | \nFor subscription accounts. The monthly subscription level. The maximum number of unique phone numbers the account can contact for the same month. | \n
| decimal PendingCallBalance | \nFor credit accounts. The number of credits to be used by pending broadcasts. | \n
| string State | \nThe billing address's state. | \n
| datetime SubscriptionEndDate | \nFor subscription accounts. The end of the monthly billing cycle. | \n
| string Uri | \nThe link to self. | \n
| string Zip | \nThe billing address's zip code. | \n
Using this endpoint a master user 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 | \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 | \nThe US state the user's time zone is in. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| integer TimeZoneOffset | \nThe number of hours difference (plus or minus) between the account's time zone and Central Standard Time. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| boolean ObservesDaylightSavings | \nWhether the user's time zone observes daylight savings time. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| phone-number CallerIDNumber | \nThe phone number displayed on the recipient's caller ID. [Optional: If omitted the number in the Phone input property is used.] | \n
| array of days CallingWindowDays | \nThe list of the day's names that call broadcasts are allowed to send. [Optional: If omitted broadcasts can be sent on all days of the week.] | \n
| integer CallThrottle | \nCall speed. An upper limit on the number of simultaneous calls that can be ongoing at any given time. [Optional: The default is maximum speed.] | \n
| boolean DefaultContinueOnNextDay | \nAre calls to continue on the next day if the broadcast doesn't complete today? [Optional: The default value is false.] | \n
| integer DefaultMaxMessageLength | \nThe time limit, in seconds, for voice broadcast messages. [Optional: If omitted, the master user's maximum message length gets set.] | \n
| integer DefaultRetryTimes | \nThe number of times a call will be retried before giving up. [Optional: The default value is 1.] | \n
| integer DefaultTextSegments | \nThe number of text segments for text broadcast messages. [Optional: If omitted, the master user's text segment limit gets set.] | \n
| phone-number NotificationPhone | \nThe phone number that can be set up to get text notifications at set times if the user has unread message replies. [Optional: If omitted the number in the Phone input property is used.] | \n
| permissions Permissions | \nUser permissions. [Optional: If omitted the user has only has access to his/her own audio, contacts and broadcasts.] | \n
| password PinCode | \nThe login password. [Optional: If omitted a random password is generated.] | \n
| phone-number SMSLaunchPhone | \nThe user's authorized number for texts launched by phone. [Optional: If omitted the number in the Phone input property is used.] | \n
| time-of-day StartTimeOfDay | \nThe earliest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 AM.] | \n
| time-of-day StopTimeOfDay | \nThe latest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 PM.] | \n
| username Username | \nThe login username. [Optional: If omitted a random username is generated.] | \n
Calling this endpoint you can change an account user's properties.
\nThe request body contains a User model describing the new values to be updated.
\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":"73aed5fd-69fa-4792-bbbd-94141c532afa","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 \"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":"87e969e0-d9f6-4435-8f03-14774b07f1d3","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 \"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":"d2d2981c-403e-4a79-bb2c-0b76c811ef59","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 \"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":"d79789a9-01a0-417e-9f75-14eff2e41ddd","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 \"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":"a75419ef-bda9-4274-a5e7-68750ab7fa2f"}],"id":"4551d91c-1196-41fd-b19f-ad8b0ff50e13","description":"Your account informations.
\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"b2db2cad-dcc5-4d39-a254-e72e984cd3f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e2bba4a7-72e7-424d-9e4e-3f3ff09ad24e","type":"text/javascript","exec":[""]}}],"_postman_id":"4551d91c-1196-41fd-b19f-ad8b0ff50e13"}],"id":"e21d25a7-a407-4441-a6e2-3260085e6dfd","description":"The API endpoints available in the Text-Em-All Rest API.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"e21d25a7-a407-4441-a6e2-3260085e6dfd"},{"name":"API Models","item":[{"name":"Time Of Day","item":[],"id":"8a4d1169-5d03-4c32-ab67-3af39da50977","description":"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
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 | \nWhether the user can have access to all contacts on the account that other users created. | \n
| boolean CanSeeAllAudio | \nWhether the user can have access to all audio on the account that other users created. | \n
| boolean CanSeeGroupAudio | \nWhether the user can have access to the group audio. These are audio from the audio library that are shared accross accounts of the same client. | \n
An object describing the properties and setting 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 | \nThe US state the user's time zone is in. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| integer TimeZoneOffset | \nThe number of hours difference (plus or minus) between the account's time zone and Central Standard Time. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| boolean ObservesDaylightSavings | \nWhether the user's time zone observes daylight savings time. Either State or TimeZoneOffset and ObservesDaylightSavings is required to be specified. | \n
| phone-number CallerIDNumber | \nThe phone number displayed on the recipient's caller ID. [Optional: If omitted the number in the Phone input property is used.] | \n
| array of days CallingWindowDays | \nThe list of the day's names that call broadcasts are allowed to send. [Optional: If omitted broadcasts can be sent on all days of the week.] | \n
| integer CallThrottle | \nCall speed. An upper limit on the number of simultaneous calls that can be ongoing at any given time. [Optional: The default is maximum speed.] | \n
| boolean DefaultContinueOnNextDay | \nAre calls to continue on the next day if the broadcast doesn't complete today? [Optional: The default value is false.] | \n
| integer DefaultMaxMessageLength | \nThe time limit, in seconds, for voice broadcast messages. [Optional: If omitted, the master user's maximum message length gets set.] | \n
| integer DefaultRetryTimes | \nThe number of times a call will be retried before giving up. [Optional: The default value is 1.] | \n
| integer DefaultTextSegments | \nThe number of text segments for text broadcast messages. [Optional: If omitted, the master user's text segment limit gets set.] | \n
| phone-number NotificationPhone | \nThe phone number that can be set up to get text notifications at set times if the user has unread message replies. [Optional: If omitted the number in the Phone input property is used.] | \n
| permissions Permissions | \nUser permissions. [Optional: If omitted the user has only has access to his/her own audio, contacts and broadcasts.] | \n
| password PinCode | \nThe login password. [Optional: If omitted a random password is generated.] | \n
| phone-number SMSLaunchPhone | \nThe user's authorized number for texts launched by phone. [Optional: If omitted the number in the Phone input property is used.] | \n
| time-of-day StartTimeOfDay | \nThe earliest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 AM.] | \n
| time-of-day StopTimeOfDay | \nThe latest time of day to make calls. The time is relative to the account's Time Zone. [Optional: The default is 9:00 PM.] | \n
| username Username | \nThe login username. [Optional: If omitted a random username is generated.] | \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":"8d923533-893e-4886-a1b3-19592171bedd"},{"name":"Common Types","item":[{"name":"Email","item":[],"id":"9c90c3e7-1d23-4e62-b4b0-c834bd7c860f","description":"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
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. Call-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":"c36f52ca-1b15-48a6-9241-a1268a90a5a4","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","name":"Common Types","type":"folder"}}},{"name":"PIN / Password","item":[],"id":"ec99bf60-3381-454a-8451-951b55dbd460","description":"In combination with a Username, the Personal Identification Number (PIN) authenticates a Call-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 Call-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":"ec99bf60-3381-454a-8451-951b55dbd460","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","name":"Common Types","type":"folder"}}},{"name":"Username","item":[],"id":"8d7752c7-be70-4a81-8da7-80ab7f4f5dce","description":"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":"8d7752c7-be70-4a81-8da7-80ab7f4f5dce","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","name":"Common Types","type":"folder"}}}],"id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4","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":"8fbe36b4-6c07-4f2c-b648-7d6dfc854509","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"497aba07-21a2-4a81-ba17-1a777ba3e853","type":"text/javascript","exec":[""]}}],"_postman_id":"1864d048-9221-4bfd-a5b3-e0011a6d82c4"}],"event":[{"listen":"prerequest","script":{"id":"43871165-8e75-4575-893a-f219426e13b0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8229ab65-94cb-42dc-8d1e-153de2b503a7","type":"text/javascript","exec":[""]}}]}