Introduction

Welcome to Call-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 Call-Em-All API.

The 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.

Account Requirements

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.

Setting Up Your Integration

To set up an integration with Call-Em-All you need to do the following:

Create a Free Trial account on https://www.call-em-all.com
Contact api@call-em-all.com to get a new integration created for you. Please let us know about the account you have created.
We are going to create a mirror image of your account in our test environment.
We will send you back an Application Key and a Secret Key for your test environment that you will use for the Api authentication.
When you have completed your development we will send you keys to our production environment as well.

User Setup

When 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.

The REST API

API Requests

The base URL for all endpoints start with: https://rest.call-em-all.com/v1
Our test environment’s base URL is: https://staging-rest.call-em-all.com/v1

The API endpoints can only be accessed through HTTPS. All requests via HTTP will result in an error, returning status code 403 - Forbidden.
The currently supported format is JSON. In all requests please set the Accept and Content-Type headers to application/json.

                
                                Headers
{
    "Accept": "application/json",
    "Content-Type": "application/json",
    "Content-Length": ...,
    ....
}

Authentication

The API uses standard OAuth version 1 for authentication. You can find libraries that implement it in most common langauages at https://oauth.net/1/. 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.

                
                                Headers
{
    ....
    "Authorization": "OAuth oauth_consumer_key="...."oauth_token="...."oauth_nonce="...."oauth_timestamp="...."oauth_signature_method="HMAC-SHA1"oauth_version="1.0"oauth_signature="...."",
    ....
}

Response

An API request will return an HTTP status code and one of the following type of data in the response body.

A single resource
A collection (feed) of resources
An error object

Errors

On unsuccessful requests along with the return code the response body may contains the following Error resource model:

                
                                {
    "ErrorCode": 200,
    "ErrorType": "Informational",
    "Message": "CreateDate cannot be used as a search parameter.",
}

Collections/Feeds

Collections 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.

Feed query parameters

page={p}	The page number.
pagesize={n}	The number of items a page has.
takesize={t}	How many items to return. (Generally should equal to pagesize.)

Example

                
                                 /broadcasts?StartDate~gte~2014-01-01&CreatedDate~gte~2014-01-01&sortby=-CreatedDate&pagesize=1

                
                    
                            
                            
                                {
    "Size": 5,
    "Items": 
    [
        {
            "Uri": "/v1/broadcasts/23718",
            "UriBroadcastDetails": "/v1/broadcasts/23718/details",
            "BroadcastName": "Test Broadcast",
            "BroadcastType": "Announcement",
            "BroadcastStatus": "Complete",
            "CreatedDate": "2014-02-24 15:54:12-0600",
            "StartDate": "2014-02-24 15:54:13-0600",
            "CallerID": "9725551212",
            "CreditsUsed": 1.00,
            "PhoneNumberCount": 1,
            "TotalCompleted": 1,
            "RetryTimes": 1,
            "CallThrottle": 0,
            "LivePersonTotal": 1,
            "AnsweringMachineTotal": 0,
            "BusyNoAnswerTotal": 0,
            "InvalidNumberTotal": 0,
            "SurveyResponseTotal": 0,
            "SurveyResponses": null,
        }
    ],
    "Previous": null,
    "Next": "/broadcasts?StartDate~gte~2014-01-01&CreatedDate~gte~2014-01-01&sortby=-CreatedDate&pagesize=1&page=2",
}

                            
                        

                
            

Search and Sort

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.

                
                                GET /broadcasts?StartDate~gte~2014-01-01&amp;StartDate~lt~2014-01-02&amp;BroadcastStatus=Completed

Separate your search criteria with the ’&’ sign. In each search criteria have the field name on the left and constant value on the right.

Operators as follows. (Please refer to the documentation of each endpoint to see which operators are valid).

=	equals
~lt~	less than
~lte~	less than or equal
~gt~	greater than
~gte~	greater than or equal

Use 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.

Example

GET /broadcasts?sortby=-StartDate,-CreateDate

Request Rate Limit

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.

REST API Endpoints

Account

Create User

Create a new user for the account. Your account has to have a special permission level to be able to create new messengers. Please contact api@call-em-all.com if you need that functionality enabled.

Example

POST /account/users

POST /account/users

Request Property	Description
String UserName	The Username for logging in to the call-em-all site.
String PinCode (R)	The Password for logging in to the call-em-all site.
String FirstName	The user's first name.
String LastName	The user's last name.
String Email	The user's email contact.
String Phone	The user's phone contact.
String CallerID	The default phone number the calls appear to be coming from.
Integer Retries	The default number of call retries attempted in case of busy tone or ring no answer. The default value is 1.
Integer MaxMessageLength	The default maximum voice message length in seconds that the user can use. The default value is 120.
Integer CallThrottle	The default call speed. It controls how many voice calls are being up at any given time.
Model StartTimeOfDay	The start of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Model StopTimeOfDay	The end of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Boolean ContinueOnNextDay	The default behavior on how to handle calls that could not be completed because of reaching the end of the calling window.
ArrayList CallingWindowDays	The list of days that calls are limited to. E.g. "Monday", "Tuesday". All days of the week if empty.
String State	The State the user resides in. The State determines the default time zone for the start time of the calls.
Model Permissions	The user permissions.

                
                    
                            
                            
                                {
    "UserName": "apitest@cea",
    "PinCode": "notmypwd123!!!",
    "FirstName": "Luke",
    "LastName": "Skywalker",
    "Email": "luke@galaxy.com",
    "Phone": "2027075000",
    "State": "TX",
    "CallerID": "2027075000",
    "CallThrottle": 10,
    "StartTimeOfDay": 
    {
        "Hour": 7,
        "Minute": 0,
    },
    "StopTimeOfDay": 
    {
        "Hour": 20,
        "Minute": 0,
    },
    "ContinueOnNextDay": true,
    "Retries": 1,
    "MaxMessageLength": 120,
    "Permissions": 
    {
        "CanSeeAllBroadcasts": true,
        "CanSeeAllRoster": true,
        "CanSeeGroupAudio": true,
    }
}

                            
                        

                
            

Response Property	Description
Integer UserID	The unique resource ID for the user.
String UserName	The Username for logging in to the call-em-all site.
String FirstName	The user's first name.
String LastName	The user's last name.
String Email	The user's email contact.
String Phone	The user's phone contact.
String CallerID	The default phone number the calls appear to be coming from.
Integer Retries	The default number of call retries attempted in case of busy tone or ring no answer. The default value is 1.
Integer MaxMessageLength	The default maximum voice message length in seconds that the user can use. The default value is 120.
Integer CallThrottle	The default call speed. It controls how many voice calls are being up at any given time.
Model StartTimeOfDay	The start of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Model StopTimeOfDay	The end of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Boolean ContinueOnNextDay	The default behavior on how to handle calls that could not be completed because of reaching the end of the calling window.
ArrayList CallingWindowDays	The list of days that calls are limited to. E.g. "Monday", "Tuesday". All days of the week if empty.
String State	The State the user resides in. The State determines the default time zone for the start time of the calls.
Model Permissions	The user permissions.

                
                    
                            
                            
                                {
    "UserID": 208867,
    "UserName": "apitest@cea",
    "FirstName": "Luke",
    "LastName": "Skywalker",
    "Email": "luke@galaxy.com",
    "Phone": "2027075000",
    "CallerID": "2027075000",
    "Retries": 1,
    "MaxMessageLength": 120,
    "CallThrottle": 10,
    "ContinueOnNextDay": true,
    "StartTimeOfDay": 
    {
        "Hour": 7,
        "Minute": 0,
    },
    "StopTimeOfDay": 
    {
        "Hour": 20,
        "Minute": 0,
    },
    "CallingWindowDays": 
    [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
    ],
    "State": "TX",
    "Permissions": 
    {
        "CanSeeAllBroadcasts": true,
        "CanSeeAllRoster": true,
        "CanSeeAllAudio": true,
        "CanSeeGroupAudio": true,
    }
}

                            
                        

                
            

Update User Settings

Update settings for a User. Users can change their own settings except their permissions. Also, a master user has access to change all other users settings on the same account.

The settings that can be updated are listed below.

Example

PUT /account/users/123

PUT /account/users/208867

Request Property	Description
String UserName	The Username for logging in to the call-em-all site.
String PinCode (R)	The Password for logging in to the call-em-all site.
String FirstName	The user's first name.
String LastName	The user's last name.
String Email	The user's email contact.
String Phone	The user's phone contact.
String CallerID	The default phone number the calls appear to be coming from.
Integer Retries	The default number of call retries attempted in case of busy tone or ring no answer. The default value is 1.
Integer MaxMessageLength	The default maximum voice message length in seconds that the user can use. The default value is 120.
Integer CallThrottle	The default call speed. It controls how many voice calls are being up at any given time.
Model StartTimeOfDay	The start of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Model StopTimeOfDay	The end of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Boolean ContinueOnNextDay	The default behavior on how to handle calls that could not be completed because of reaching the end of the calling window.
ArrayList CallingWindowDays	The list of days that calls are limited to. E.g. "Monday", "Tuesday". All days of the week if empty.
Model Permissions	The user permissions.

                
                                {
    "Permissions": 
    {
        "CanSeeAllBroadcasts": true,
    }
}

Response Property	Description
Integer UserID	The unique resource ID for the user.
String UserName	The Username for logging in to the call-em-all site.
String PinCode (R)	The Password for logging in to the call-em-all site.
String FirstName	The user's first name.
String LastName	The user's last name.
String Email	The user's email contact.
String Phone	The user's phone contact.
String CallerID	The default phone number the calls appear to be coming from.
Integer Retries	The default number of call retries attempted in case of busy tone or ring no answer. The default value is 1.
Integer MaxMessageLength	The default maximum voice message length in seconds that the user can use. The default value is 120.
Integer CallThrottle	The default call speed. It controls how many voice calls are being up at any given time.
Model StartTimeOfDay	The start of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Model StopTimeOfDay	The end of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Boolean ContinueOnNextDay	The default behavior on how to handle calls that could not be completed because of reaching the end of the calling window.
ArrayList CallingWindowDays	The list of days that calls are limited to. E.g. "Monday", "Tuesday". All days of the week if empty.
String State	The State the user resides in. The State determines the default time zone for the start time of the calls.
Model Permissions	The user permissions.

                
                    
                            
                            
                                {
    "UserID": 208867,
    "UserName": "apitest@cea",
    "FirstName": "Luke",
    "LastName": "Skywalker",
    "Email": "luke@galaxy.com",
    "Phone": "2027075000",
    "CallerID": "2027075000",
    "Retries": 1,
    "MaxMessageLength": 120,
    "CallThrottle": 10,
    "ContinueOnNextDay": true,
    "StartTimeOfDay": 
    {
        "Hour": 7,
        "Minute": 0,
    },
    "StopTimeOfDay": 
    {
        "Hour": 20,
        "Minute": 0,
    },
    "CallingWindowDays": 
    [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
    ],
    "State": "TX",
    "Permissions": 
    {
        "CanSeeAllBroadcasts": true,
        "CanSeeAllRoster": true,
        "CanSeeAllAudio": true,
        "CanSeeGroupAudio": true,
    }
}

                            
                        

                
            

Broadcasts

Create Broadcast

Creating a broadcast sets up a broadcast for a user in one call. The request model contains all information needed - the name, the type, the start time, the contacts, the message and optional parameters. Depending on the BroadcastType specified different request properties are required.

Example

POST /broadcasts

POST /broadcasts

Request Property	Description
String BroadcastName	The name of the broadcast.
String BroadcastType	The type of the broadcast.
String StartDate	The broadcast start time.
String CallerID	The phone number the voice call is initiated from.
Model TransferAndConnect	The settings for transfer and connect broadcasts. Null otherwise.
Model Audio	The assigned audio message for voice broadcasts.
Model AudioVM	The assigned audio message for survey and transfer and connect broadcasts to be played when voicemail is reached.
Integer RetryTimes	The number of times a call is retried after busy signal or no answer. The default valus is 1.
Integer CallThrottle	The call speed specifies how many calls can be connected at the same time. No restrictions by default.
Integer MaxMessageLength	The maximum number of seconds the audio message can be.
String TextMessage	The text of the text message.
Integer TextNumberID	The resource ID for the text number used in th conversation.
Boolean CheckCallingWindow	Whether to enforce or ignore the user's calling window.
Boolean ContinueOnNextDay	Can override the continue on next the day default user setting.
Boolean PrimaryPhoneNumbersOnly	Whether to use the primary phones only on the contacts specified when creating the broadcast.
Integer DraftBroadcastID	Create the broadcast using this draft broadcast previously assembled.
ArrayList Lists	Include all contacts from the Contact Groups listed to the broadcast.
ArrayList Contacts	Include all contacts listed to the broadcast.
ArrayList ExcludedContacts	Exclude all contacts listed from the broadcast.
ArrayList FileUploads	Include all contacts from the File Uploads listed to the broadcast.

                
                    
                            
                            
                                {
    "BroadcastName": "Testing",
    "BroadcastType": "Announcement",
    "StartDate": "2/1/2020 1:15PM",
    "CheckCallingWindow": true,
    "Lists": 
    [
        {
            "ListID": 2,
        },
        {
            "ListID": 14,
        },
    ],
    "Contacts": 
    [
        {
            "FirstName": "Jack",
            "LastName": "Black",
            "PrimaryPhone": "2145551234",
            "Notes": "ID 123456",
            "IntegrationData": "A67CH829",
        }
    ],
    "Audio": 
    {
        "AudioID": "zx1234",
    }
}

                            
                        

                
            

Response Property	Description
String Uri	The link to self.
String UriBroadcastDetails	The link to the individual phone detail records.
Integer BroadcastID	The broadcast model's unique identifier.
String BroadcastName	The name of the broadcast.
String BroadcastType	The type of the broadcast.
String BroadcastStatus	The status of the broadcast.
String BroadcastStatusCategory	The category the broadcast status belongs to.
String CreatedDate	The broadcast creation time.
String StartDate	The broadcast start time.
String CompletedDate	The broadcast's completion time.
String CallerID	The phone number the voice call is initiated from.
Float CreditsUsed	The number of credits the broadcast used up.
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.
Model User	The user that created the broadcast.
Model TransferAndConnect	The settings for transfer and connect broadcasts. Null otherwise.
Model Audio	The assigned audio message for voice broadcasts.
Model AudioVM	The assigned audio message for survey and transfer and connect broadcasts to be played when voicemail is reached.
Integer RetryTimes	The number of times a call is retried after busy signal or no answer. The default valus is 1.
Integer CallThrottle	The call speed specifies how many calls can be connected at the same time. No restrictions by default.
Integer LivePersonTotal	The total number of calls that reached a live person.
Integer AnsweringMachineTotal	The total number of calls that reached voicemail.
Integer BusyNoAnswerTotal	The total number of calls that were not answered.
Integer InvalidNumberTotal
Integer SurveyResponseTotal	The total number of calls that responded to the survey question.
Integer TransferTotal	The total number of calls that elected to transfer.
Model SurveyResponses	The number of times each digit selected to the survey question.
Integer MaxMessageLength	The maximum number of seconds the audio message can be.
Model MessageRecordingInstruction	Instructions for how to record the audio message for the broadcast.
Integer EstimatedDuration	The number of minutes the broadcast completion is estimated to take.
String EstimatedCompletion	The date the broadcast is estimated to complete by.
Boolean ExcludedDaysIgnored	Whether the user's settings of the default days to limit making calls on should be ignored.
Boolean CallingWindowIgnored	Whether the user's settings of the default calling window should be ignored.
Boolean NotEnoughTimeToComplete	Whether it is estimated that the calls would not be able complete inside the calling window.
String TextMessage	The text of the text message.
Integer DeliveredTexts	The count of contacts the text message was successfully sent to.
Integer NotDeliveredTexts	The count of contacts the text message was failed to sent.
Integer InvalidTextCount	The count of the text broadcast's phone numbers that were invalid.
Integer TextReplies	The number of replies received to a text broadcast.
Integer TextOptedOut	The number of contacts opted out after receiving the text broadcast.
Integer TextNumberID	The resource ID for the text number used in th conversation.
String TextPhoneNumber	The toll free number or local number the text broadcast was sent from. Null for short code texting.
Integer TextBroadcastID	Creating a combo broadcast results in creating two separate broadcasts. The response from the call populates both the CallBroadcastID and TextBroadcastID fields.
Boolean HasCustomField	Whether the text broadcast's message is customzied with the contact data. For example "Hi {{FirstName}}!". If it is true, the actual text message sent out can be retrieved from the broadcast details.

                
                                {
    "BroadcastID": 1234535,
    "PhoneNumberCount": 7,
    ...
}

Query Broadcasts

List or search broadcasts. The query will only return broadcasts that the user has access to. That is broadcasts created by the user or all broadcasts if the user has privileges set to see all broadcasts on the account. It does not return previously deleted broadcasts. Query parameters listed below can be used to filter and sort the result.

The query returns a feed of broadcasts. Use the PageSize and Page query parameters to retrieve all records.

Example

GET /broadcasts

GET /broadcasts

                
                    
                            
                            
                                {
    "Size": 1,
    "Items": 
    [
        {
            "Uri": "/v1/broadcasts/23718",
            "UriBroadcastDetails": "/v1/broadcasts/23718/details",
            "BroadcastName": "Test Broadcast",
            "BroadcastType": "Announcement",
            "BroadcastStatus": "Complete",
            "CreatedDate": "2014-01-01 15:54:12-0600",
            "StartDate": "2014-01-01 15:54:13-0600",
            "CallerID": "9725551212",
            "CreditsUsed": 1.00,
            "PhoneNumberCount": 1,
            "TotalCompleted": 1,
            "RetryTimes": 1,
            "CallThrottle": 0,
            "LivePersonTotal": 1,
            "AnsweringMachineTotal": 0,
            "BusyNoAnswerTotal": 0,
            "InvalidNumberTotal": 0,
            "SurveyResponseTotal": 0,
            "SurveyResponses": null,
        }
    ],
    "Previous": null,
    "Next": "/broadcasts?StartDate~gte~2014-01-01&StartDate~lte~2014-01-02& BroadcastStatus=Completed&pagesize=10&page=2",
}

                            
                        

                
            

Get Broadcast

Get a single call broadcast.

Example

GET /broadcasts/{:id}

GET /v1/broadcasts/39609

Response Property	Description
String Uri	The link to self.
String UriBroadcastDetails	The link to the individual phone detail records.
Integer BroadcastID	The broadcast model's unique identifier.
String BroadcastName	The name of the broadcast.
String BroadcastType	The type of the broadcast.
String BroadcastStatus	The status of the broadcast.
String BroadcastStatusCategory	The category the broadcast status belongs to.
String CreatedDate	The broadcast creation time.
String StartDate	The broadcast start time.
String CompletedDate	The broadcast's completion time.
String CallerID	The phone number the voice call is initiated from.
Float CreditsUsed	The number of credits the broadcast used up.
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.
Model User	The user that created the broadcast.
Model TransferAndConnect	The settings for transfer and connect broadcasts. Null otherwise.
Model Audio	The assigned audio message for voice broadcasts.
Model AudioVM	The assigned audio message for survey and transfer and connect broadcasts to be played when voicemail is reached.
Integer RetryTimes	The number of times a call is retried after busy signal or no answer. The default valus is 1.
Integer CallThrottle	The call speed specifies how many calls can be connected at the same time. No restrictions by default.
Integer LivePersonTotal	The total number of calls that reached a live person.
Integer AnsweringMachineTotal	The total number of calls that reached voicemail.
Integer BusyNoAnswerTotal	The total number of calls that were not answered.
Integer InvalidNumberTotal
Integer SurveyResponseTotal	The total number of calls that responded to the survey question.
Integer TransferTotal	The total number of calls that elected to transfer.
Model SurveyResponses	The number of times each digit selected to the survey question.
Integer MaxMessageLength	The maximum number of seconds the audio message can be.
Model MessageRecordingInstruction	Instructions for how to record the audio message for the broadcast.
Integer EstimatedDuration	The number of minutes the broadcast completion is estimated to take.
String EstimatedCompletion	The date the broadcast is estimated to complete by.
Boolean ExcludedDaysIgnored	Whether the user's settings of the default days to limit making calls on should be ignored.
Boolean CallingWindowIgnored	Whether the user's settings of the default calling window should be ignored.
Boolean NotEnoughTimeToComplete	Whether it is estimated that the calls would not be able complete inside the calling window.

                
                    
                            
                            
                                {
    "Uri": "/v1/broadcasts/39609",
    "UriBroadcastDetails": "/v1/broadcasts/39609/details",
    "BroadcastID": 39609,
    "BroadcastName": "Test",
    "BroadcastType": "Announcement",
    "BroadcastStatus": "Complete",
    "BroadcastStatusCategory": "Completed",
    "CreatedDate": "2017-05-25 17:54:12-0500",
    "StartDate": "2017-05-25 17:54:11-0500",
    "CompletedDate": "2017-05-25 17:54:53-0500",
    "CallerID": "5052053399",
    "CreditsUsed": 1.0,
    "PhoneNumberCount": 1,
    "TotalCompleted": 1,
    "User": 
    {
        "Uri": "/v1/account/users/73312",
        "UserID": 73312,
    },
    "TransferAndConnect": null,
    "Audio": 
    {
        "Uri": "/v1/audio/af0277",
        "AudioID": "af0277",
    },
    "AudioVM": null,
    "RetryTimes": 1,
    "CallThrottle": 0,
    "LivePersonTotal": 1,
    "AnsweringMachineTotal": 0,
    "BusyNoAnswerTotal": 0,
    "InvalidNumberTotal": 0,
    "SurveyResponseTotal": 0,
    "TransferTotal": 0,
    "SurveyResponses": null,
    "MaxMessageLength": 30,
    "ExcludedDaysIgnored": false,
    "CallingWindowIgnored": false,
}

                            
                        

                
            

Get Broadcast

Get a single text broadcast.

Example

GET /broadcasts/{:id}

GET /v1/broadcasts/33945

Response Property	Description
String Uri	The link to self.
String UriBroadcastDetails	The link to the individual phone detail records.
Integer BroadcastID	The broadcast model's unique identifier.
String BroadcastName	The name of the broadcast.
String BroadcastType	The type of the broadcast.
String BroadcastStatus	The status of the broadcast.
String BroadcastStatusCategory	The category the broadcast status belongs to.
String CreatedDate	The broadcast creation time.
String StartDate	The broadcast start time.
String CompletedDate	The broadcast's completion time.
Float CreditsUsed	The number of credits the broadcast used up.
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.
Model User	The user that created the broadcast.
Integer EstimatedDuration	The number of minutes the broadcast completion is estimated to take.
String EstimatedCompletion	The date the broadcast is estimated to complete by.
Boolean NotEnoughTimeToComplete	Whether it is estimated that the calls would not be able complete inside the calling window.
String TextMessage	The text of the text message.
Integer DeliveredTexts	The count of contacts the text message was successfully sent to.
Integer NotDeliveredTexts	The count of contacts the text message was failed to sent.
Integer InvalidTextCount	The count of the text broadcast's phone numbers that were invalid.
Integer TextReplies	The number of replies received to a text broadcast.
Integer TextOptedOut	The number of contacts opted out after receiving the text broadcast.
Integer TextNumberID	The resource ID for the text number used in th conversation.
String TextPhoneNumber	The toll free number or local number the text broadcast was sent from. Null for short code texting.
Integer TextBroadcastID	Creating a combo broadcast results in creating two separate broadcasts. The response from the call populates both the CallBroadcastID and TextBroadcastID fields.
Boolean HasCustomField	Whether the text broadcast's message is customzied with the contact data. For example "Hi {{FirstName}}!". If it is true, the actual text message sent out can be retrieved from the broadcast details.

                
                    
                            
                            
                                {
    "Uri": "/v1/broadcasts/33945",
    "UriBroadcastDetails": "/v1/broadcasts/33945/details",
    "BroadcastID": 33945,
    "BroadcastName": "staging test",
    "BroadcastType": "SMS",
    "BroadcastStatus": "Complete",
    "BroadcastStatusCategory": "Completed",
    "CreatedDate": "2016-07-14 16:18:55-0500",
    "StartDate": "2016-07-14 16:18:47-0500",
    "CompletedDate": "2016-07-14 16:19:12-0500",
    "CallerID": "3125936821",
    "CreditsUsed": 0.5,
    "PhoneNumberCount": 1,
    "TotalCompleted": 1,
    "User": 
    {
        "Uri": "/v1/account/users/73312",
        "UserID": 73312,
    },
    "TextMessage": "This is a staging test",
    "DeliveredTexts": 1,
    "NotDeliveredTexts": 0,
    "InvalidTextCount": 0,
    "TextReplies": 1,
    "TextOptedOut": 0,
    "TextPhoneNumber": null,
    "TextBroadcastID": 0,
    "HasCustomField": false,
}

                            
                        

                
            

Broadcasts Details

Query Broadcast Details (Call)

List or search the call or text results of a single broadcast. The user has to have access to the broadcast. Depending on the broadcast type different properties are filled in the response model. Query parameters listed below can be used to filter and sort the result.

The query returns a feed of broadcasts details. Use the PageSize and Page query parameters to retrieve all records.

Example

GET /broadcasts/{:id}/details

GET /v1/broadcasts/39609/details

Response Property	Description
Integer Size	The total number of items in the feed altogether.
ArrayList Items	One page of items in the feed.
String Previous	The link to the previous page of items in the feed. Null on the first page.
String Next	The link to the next page of items in the feed. Null on the last page.

                
                    
                            
                            
                                {
    "Size": 1,
    "Items": 
    [
        {
            "UriCallBroadcast": "/v1/broadcasts/39609",
            "PhoneNumber": "2145555055",
            "NumberOfAttempts": 1,
            "LastCallTime": "2017-05-25 17:54:53-0500",
            "FirstName": "John",
            "LastName": "Doe",
            "Notes": null,
            "IntegrationData": "A67CH829",
            "SurveyResult": null,
            "CallResultCategory": "Live Answer",
            "CallStatus": "Completed",
            "TransferDuration": 0,
            "TransferCredits": 0.0,
            "IsTransferInitiated": false,
        }
    ],
    "Previous": null,
    "Next": null,
}

                            
                        

                
            

Query Broadcast Details (Text)

Example: Get the broadcast results for a completed text broadcast.

Example

GET /broadcasts/{:id}/details

GET /broadcasts/{:id}/details

                
                    
                            
                            
                                {
    "Size": 1,
    "Items": 
    [
        {
            "UriCallBroadcast": "/v1/broadcasts/23718",
            "PhoneNumber": "9401234443",
            "FirstName": "John",
            "LastName": "Doe",
            "Notes": null,
            "IntegrationData": "A67CH829",
            "TextResultCategory": "Sent",
            "TextStatus": "Completed",
        }
    ],
    "Previous": null,
    "Next": null,
}

                            
                        

                
            

Conversations

A conversation is a thread of chat messages between a text number and a person’s phone number. Using the Call-Em-All Rest-Api an integration has access to all of the user's conversations. You are also able to access the all text messages of a conversation in case you want to store them on the client’s side. Additionally, Call-Em-All has web-hook notifications, to report on new incoming text message arriving to any of the user’s text numbers.

Get Conversation

Look up a single conversation by text number and phone number.

Example

GET /v1/conversations/single

GET /v1/conversations/single?textphonenumber=18338028132&phonenumber=2145555055

Response Property	Description

                
                                {
    "ConversationID": 10228,
    "TextNumberID": 98615,
    "PhoneNumber": "2145555055",
    "IsDone": false,
    "IsAutoOptOut": false,
    "FirstName": "James",
    "LastName": "Polk",
    "Notes": null,
    "IntegrationData": "A67CH829",
    "TextPhoneNumber": "18338028132",
}

Contacts

Query Contacts

List or search contacts. Query parameters listed below can be used to filter and sort the result.

The query returns a feed of contacts. Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.

Example

GET /v1/contacts

GET /v1/contacts

Response Property	Description
Integer Size	The total number of items in the feed altogether.
ArrayList Items	One page of items in the feed.
String Previous	The link to the previous page of items in the feed. Null on the first page.
String Next	The link to the next page of items in the feed. Null on the last page.

                
                    
                            
                            
                                {
    "Size": 4233,
    "Items": 
    [
        {
            "Uri": "/v1/contacts/4947403",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554846",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947408",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554875",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947411",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554877",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947420",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554902",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947423",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554904",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947426",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554907",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947429",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554910",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947432",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554913",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947441",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554942",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        },
        {
            "Uri": "/v1/contacts/4947437",
            "FirstName": "",
            "LastName": "",
            "PrimaryPhone": "2145554919",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "",
        }
    ],
    "Previous": null,
    "Next": "/v1/contacts?page=2",
}

                            
                        

                
            

Get Contact

Get a single contact by its unique ID.

Example

GET /v1/contacts/{:id}

GET /v1/contacts/4947403

Response 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).
String PrimaryPhone	The primary phone number (required).
String SecondaryPhone	An optional secondary phone number.
String 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.
String 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.
String 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.
String TertiaryPhoneTextOptInStatus	The text opt-in status for the tertiary phone number.
String LastUpdated	The last time the contact was changed.
ArrayList Lists	The list of groups the contact is a member of.

                
                                {
    "Uri": "/contacts/4947403",
    "FirstName": "Bob",
    "LastName": "Lilly",
    "PrimaryPhone": "2145554846",
    "SecondaryPhone": "",
    "TertiaryPhone": "",
    "Notes": "",
}

Create Contact

Create a contact in the Everyone list.

Example

POST /v1/contacts

POST /v1/contacts

Request 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).
String PrimaryPhone	The primary phone number (required).
String SecondaryPhone	An optional secondary phone number.
String 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.
String 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.
String 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.
String TertiaryPhoneTextOptInStatus	The text opt-in status for the tertiary phone number.
String LastUpdated	The last time the contact was changed.
ArrayList Lists	The list of groups the contact is a member of.

                
                                {
    "PrimaryPhone": "2145555055",
    "FirstName": "John",
    "LastName": "Doe",
    "Notes": "cell",
}

Response 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).
String PrimaryPhone	The primary phone number (required).
String SecondaryPhone	An optional secondary phone number.
String 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.
String 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.
String 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.
String TertiaryPhoneTextOptInStatus	The text opt-in status for the tertiary phone number.
String LastUpdated	The last time the contact was changed.
ArrayList Lists	The list of groups the contact is a member of.

                
                                {
    "Uri": "/v1/contacts/4951360",
    "FirstName": "John",
    "LastName": "Doe",
    "PrimaryPhone": "2145555055",
    "SecondaryPhone": "",
    "TertiaryPhone": "",
    "Notes": "cell",
    "PersonID": 4951360,
}

Delete Contact

Delete a single contact using its unique ID.

Example

DELETE /v1/contacts/{:id}

DELETE /v1/contacts/4947403

                
                                200 - OK

Delete Contacts

Delete a collection of contacts with a single call. Contact lists are not deleted but the deleted contacts disappear from all contact lists they were members of. The body of the request can specify the contacts to be deleted. If left empty all contacts are deleted.

Example

DELETE /v1/contacts

DELETE /v1/contacts

                
                                200 - OK

Contact Lists

Query Contact Lists

List or search contact lists. The query will only return contact lists that the user has access to: contact lists created by the user or all contact lists if the user has privileges set to see all contacts on the account. Query parameters listed below can be used to filter and sort the result.

The query returns a feed of contact lists. Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.

Example

GET /v1/lists

GET /v1/lists

                
                    
                            
                            
                                {
    "Size": 5,
    "Items": 
    [
        {
            "Uri": "/v1/lists/deleted",
            "ListID": -2,
            "ListType": "System",
            "ListName": "Deleted",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2015-12-28 16:14:20.613-0600",
            "RosterCount": 29,
        },
        {
            "Uri": "/v1/lists/everyone",
            "ListID": 0,
            "ListType": "System",
            "ListName": "Everyone",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2015-12-28 16:14:20.613-0600",
            "RosterCount": 4233,
        },
        {
            "Uri": "/v1/lists/unfiled",
            "ListID": -1,
            "ListType": "System",
            "ListName": "Unfiled",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2015-12-28 16:14:20.613-0600",
            "RosterCount": 3926,
        },
        {
            "Uri": "/v1//lists/36",
            "ListID": 36,
            "ListType": "User",
            "ListName": "101",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2019-01-21 11:55:40.317-0600",
            "RosterCount": 302,
        },
        {
            "Uri": "/v1/lists/35",
            "ListID": 35,
            "ListType": "User",
            "ListName": "11 (Copy)",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2018-12-10 13:49:32.543-0600",
            "RosterCount": 0,
        }
    ],
    "Previous": null,
    "Next": null,
}

                            
                        

                
            

Get Contact List

Get a single contact list by its unique list ID.

Example

GET /v1/lists/{:id}

GET /v1/lists/34

Response Property	Description
Integer ListID	The unique resource ID for the contact group.
String ListType	The type of the contact group.
String ListName	A short name of the contact group.
String ListDescription	A longer descrpition of the contact group.
String SMSName	Used for accounts set up with short code texting. When an SMSName is assigned to the contact group, people can opt in directly to the group by texting "join SMSName" to the short code.
Boolean IsAutoReplyOn	Used for accounts set up with short code texting. When 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.
String AutoReplyMessage	Used for accounts set up with short code texting. This 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.
String LastUpdated	The last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group.
Integer RosterCount	The contact group's membership count.

                
                                {
    "Uri": "/v1/lists/34",
    "ListID": 34,
    "ListType": "User",
    "ListName": "Template Demo",
    "ListDescription": "",
    "SMSName": "",
    "IsAutoReplyOn": false,
    "AutoReplyMessage": "",
    "LastUpdated": "2018-10-31 08:34:08.11-0500",
    "RosterCount": 2,
}

Get Everyone List

Get the everyone contact list.

Example

GET /v1/lists/everyone

GET /v1/lists/everyone

Response Property	Description
Integer ListID	The unique resource ID for the contact group.
String ListType	The type of the contact group.
String ListName	A short name of the contact group.
String ListDescription	A longer descrpition of the contact group.
String SMSName	Used for accounts set up with short code texting. When an SMSName is assigned to the contact group, people can opt in directly to the group by texting "join SMSName" to the short code.
Boolean IsAutoReplyOn	Used for accounts set up with short code texting. When 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.
String AutoReplyMessage	Used for accounts set up with short code texting. This 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.
String LastUpdated	The last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group.
Integer RosterCount	The contact group's membership count.

                
                                {
    "Uri": "/v1/lists/everyone",
    "ListID": 0,
    "ListType": "System",
    "ListName": "Everyone",
    "ListDescription": "",
    "SMSName": "",
    "IsAutoReplyOn": false,
    "AutoReplyMessage": "",
    "LastUpdated": "2015-12-28 16:14:20.613-0600",
    "RosterCount": 4233,
}

Create Contact List

Create a contact list.

Example

POST /v1/lists

POST /v1/lists

Request Property	Description
Integer ListID	The unique resource ID for the contact group.
String ListType	The type of the contact group.
String ListName	A short name of the contact group.
String ListDescription	A longer descrpition of the contact group.
String SMSName	Used for accounts set up with short code texting. When an SMSName is assigned to the contact group, people can opt in directly to the group by texting "join SMSName" to the short code.
Boolean IsAutoReplyOn	Used for accounts set up with short code texting. When 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.
String AutoReplyMessage	Used for accounts set up with short code texting. This 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.
String LastUpdated	The last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group.
Integer RosterCount	The contact group's membership count.

                
                                {
    "ListName": "Test Group",
    "ListDescription": "Contact group created for test",
}

Response Property	Description
Integer ListID	The unique resource ID for the contact group.
String ListType	The type of the contact group.
String ListName	A short name of the contact group.
String ListDescription	A longer descrpition of the contact group.
String SMSName	Used for accounts set up with short code texting. When an SMSName is assigned to the contact group, people can opt in directly to the group by texting "join SMSName" to the short code.
Boolean IsAutoReplyOn	Used for accounts set up with short code texting. When 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.
String AutoReplyMessage	Used for accounts set up with short code texting. This 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.
String LastUpdated	The last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group.
Integer RosterCount	The contact group's membership count.

                
                                {
    "Uri": "/v1/lists/8",
    "ListID": 8,
    "ListType": "User",
    "ListName": "Test Group",
    "ListDescription": "Contact group created for test",
    "SMSName": "",
    "IsAutoReplyOn": false,
    "AutoReplyMessage": "",
    "LastUpdated": "2019-02-21 23:07:41.389-0600",
    "RosterCount": 0,
}

Delete Contact List

Delete a single contact list using its unique ID.

Example

DELETE /v1/lists/{:id}

DELETE /v1/lists/8

                
                                200 - OK

Contact List Membership

Query List Contacts

List or search contacts of a lists. Query parameters listed below can be used to filter and sort the result.

The query returns a feed of contacts. Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.

Example

GET /v1/lists/{:id}/contacts

GET /v1/lists/34/contacts

Response Property	Description
Integer Size	The total number of items in the feed altogether.
ArrayList Items	One page of items in the feed.
String Previous	The link to the previous page of items in the feed. Null on the first page.
String Next	The link to the next page of items in the feed. Null on the last page.

                
                    
                            
                            
                                {
    "Size": 2,
    "Items": 
    [
        {
            "Uri": "/v1/contacts/7541",
            "FirstName": "Bob",
            "LastName": "White",
            "PrimaryPhone": "5855550337",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
        },
        {
            "Uri": "/v1/contacts/8274",
            "FirstName": "Will",
            "LastName": "Grey",
            "PrimaryPhone": "5855550339",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
        }
    ],
    "Previous": null,
    "Next": null,
}

                            
                        

                
            

Remove a Contact from List

Remove a contact from a contact list.

Example

DELETE /v1/lists/{:id}/contacts/{:contactid}

DELETE /v1/lists/34/contacts/4951360

                
                                200 - OK

Remove Contacts from List

Remove a collection of contacts from a contact list. The body of the request can specify the contacts to be removed. If left empty all contacts are removed.

Example

DELETE /v1/lists/{:id}/contacts

DELETE /v1/lists/34/contacts

                
                                200 - OK

Remove Contacts from the Deleted List

Remove a collection of contacts from the Deleted folder. If a DELETE request specifies, the deleted contacts are moved to the Deleted folder so they can still be restored. This function can be used to permanently delete a collection of these contacts. The body of the request can specify the contacts to be removed. If left empty all contacts are deleted from the Trash.

Example

DELETE /v1/lists/deleted/contacts

DELETE /v1/lists/deleted/contacts

                
                                200 - OK

User

Log in User

Retrieve a user's authentication token. Passing in a user's Call-Em-All login credentials the API will return an authentication token. You can use the authentication token for all subsequent API calls. See the Authenticaton section for details.

User log in requires application level authentication. If you are using OAuth for authentication, it only needs a valid AppKey and SecretKey. The Authorization token can be any random GUID.

Example

POST /user/login

POST /user/login

Request Property	Description
String UserName (R)	Username
String PinCode (R)	Password

                
                                {
    "UserName": "apitest@cea",
    "PinCode": "notmypwd123!!!",
}

Response Property	Description
String AuthToken	Authorization token to be used in API calls.
Integer UserID	The user's unique resource ID.

                
                                {
    "UserID": 73312,
    "AuthToken": "00000000-0000-0000-0000-000000000000",
}

REST API Models

Audio

Example

Property	Description
String Uri	The link to self.
String AudioID	The audio resource's unique identifier.
String Name	The name of the audio entered by the user.
String Description	A description of the audio entered by the user.
Boolean Favorite	Whether the audio is marked as favorite.
Boolean Shared	Whether the audio is shared with all account users.
Integer Length	The audio length in seconds.
String MessageType	The broadcast type the message was used in.
Boolean ReadOnly	Whether the audio cannot be deleted by the user.
String Created	The audio creation time.
String LastUsed	The last time the audio was used in a broadcast.
Boolean TextToSpeech	Whether the audio was created using text to speech.

                
                                {
    "Uri": "/v1/audio/ag3472",
    "AudioID": "ag3472",
    "Name": "Wake up reminder",
    "Description": "This is my morning wake up reminder.",
    "Favorite": false,
    "Shared": false,
    "Length": 11,
    "MessageType": "Announcement",
    "ReadOnly": false,
    "Created": "2018-05-16 16:45:59-0500",
    "LastUsed": "2018-09-26 16:11:09-0500",
    "TextToSpeech": false,
}

Broadcast

Example

Property	Description
String Uri	The link to self.
String UriBroadcastDetails	The link to the individual phone detail records.
Integer BroadcastID	The broadcast model's unique identifier.
String BroadcastName	The name of the broadcast.
String BroadcastType	The type of the broadcast.
String BroadcastStatus	The status of the broadcast.
String BroadcastStatusCategory	The category the broadcast status belongs to.
String CreatedDate	The broadcast creation time.
String StartDate	The broadcast start time.
String CompletedDate	The broadcast's completion time.
String CallerID	The phone number the voice call is initiated from.
Float CreditsUsed	The number of credits the broadcast used up.
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.
Model User	The user that created the broadcast.
Model TransferAndConnect	The settings for transfer and connect broadcasts. Null otherwise.
Model Audio	The assigned audio message for voice broadcasts.
Model AudioVM	The assigned audio message for survey and transfer and connect broadcasts to be played when voicemail is reached.
Integer RetryTimes	The number of times a call is retried after busy signal or no answer. The default valus is 1.
Integer CallThrottle	The call speed specifies how many calls can be connected at the same time. No restrictions by default.
Integer LivePersonTotal	The total number of calls that reached a live person.
Integer AnsweringMachineTotal	The total number of calls that reached voicemail.
Integer BusyNoAnswerTotal	The total number of calls that were not answered.
Integer InvalidNumberTotal
Integer SurveyResponseTotal	The total number of calls that responded to the survey question.
Integer TransferTotal	The total number of calls that elected to transfer.
Model SurveyResponses	The number of times each digit selected to the survey question.
Integer MaxMessageLength	The maximum number of seconds the audio message can be.
Model MessageRecordingInstruction	Instructions for how to record the audio message for the broadcast.
Integer EstimatedDuration	The number of minutes the broadcast completion is estimated to take.
String EstimatedCompletion	The date the broadcast is estimated to complete by.
Boolean ExcludedDaysIgnored	Whether the user's settings of the default days to limit making calls on should be ignored.
Boolean CallingWindowIgnored	Whether the user's settings of the default calling window should be ignored.
Boolean NotEnoughTimeToComplete	Whether it is estimated that the calls would not be able complete inside the calling window.
String TextMessage	The text of the text message.
Integer DeliveredTexts	The count of contacts the text message was successfully sent to.
Integer NotDeliveredTexts	The count of contacts the text message was failed to sent.
Integer InvalidTextCount	The count of the text broadcast's phone numbers that were invalid.
Integer TextReplies	The number of replies received to a text broadcast.
Integer TextOptedOut	The number of contacts opted out after receiving the text broadcast.
Integer TextNumberID	The resource ID for the text number used in th conversation.
String TextPhoneNumber	The toll free number or local number the text broadcast was sent from. Null for short code texting.
Integer TextBroadcastID	Creating a combo broadcast results in creating two separate broadcasts. The response from the call populates both the CallBroadcastID and TextBroadcastID fields.
Boolean CheckCallingWindow	Whether to enforce or ignore the user's calling window.
Boolean ContinueOnNextDay	Can override the continue on next the day default user setting.
Boolean PrimaryPhoneNumbersOnly	Whether to use the primary phones only on the contacts specified when creating the broadcast.
Boolean HasCustomField	Whether the text broadcast's message is customzied with the contact data. For example "Hi {{FirstName}}!". If it is true, the actual text message sent out can be retrieved from the broadcast details.
Integer DraftBroadcastID	Create the broadcast using this draft broadcast previously assembled.
ArrayList Lists	Include all contacts from the Contact Groups listed to the broadcast.
ArrayList Contacts	Include all contacts listed to the broadcast.
ArrayList ExcludedContacts	Exclude all contacts listed from the broadcast.
ArrayList FileUploads	Include all contacts from the File Uploads listed to the broadcast.

                
                    
                            
                            
                                {
    "Uri": "/v1/broadcasts/33945",
    "UriBroadcastDetails": "/v1/broadcasts/33945/details",
    "BroadcastID": 33945,
    "BroadcastName": "staging test",
    "BroadcastType": "SMS",
    "BroadcastStatus": "Complete",
    "BroadcastStatusCategory": "Completed",
    "CreatedDate": "2016-07-14 16:18:55-0500",
    "StartDate": "2016-07-14 16:18:47-0500",
    "CompletedDate": "2016-07-14 16:19:12-0500",
    "CallerID": "3125936821",
    "CreditsUsed": 0.5,
    "PhoneNumberCount": 1,
    "TotalCompleted": 1,
    "User": 
    {
        "Uri": "/v1/account/users/73312",
        "UserID": 73312,
    },
    "TextMessage": "This is a staging test",
    "DeliveredTexts": 1,
    "NotDeliveredTexts": 0,
    "InvalidTextCount": 0,
    "TextReplies": 1,
    "TextOptedOut": 0,
    "TextPhoneNumber": null,
    "TextBroadcastID": 0,
    "HasCustomField": false,
}

                            
                        

                
            

BroadcastDetail

Example

Property	Description
String UriCallBroadcast	The link to the broadcast.
String PhoneNumber	The contacted phone number.
Integer NumberOfAttempts	The number of attempts made to contact the number.
String LastCallTime	The last attempt to contact the number.
String FirstName	The contact's first name.
String LastName	The contact's last name.
String Notes	The contact's notes field. Maximum length is 50 characters.
String IntegrationData	Data field for a 3rd party integration ID. Maximum length is 512 characters.
String SurveyResult	(Survey only) The survey response the called party responded with.
String CallResultCategory	(Call only) The result of the call attempt made.
String CallStatus	(Call only) The status of the call.
Integer TransferDuration	(Call only) The number of seconds on a transfer the two parties remained on the line.
Float TransferCredits	(Call only) The number of credits the transfer portion of the call cost.
Boolean IsTransferInitiated	(Call only) Whether the called party initiated a transfer by pressing STAR ZERO.
String TextStatus	(Text only) The status of the text.
String TextResultCategory	(Text only) The result of the text attempt made.
String TextMessage	(Text only) The 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}}!")status of the text.

                
                    
                            
                            
                                {
    "UriCallBroadcast": "/v1/broadcasts/39609",
    "PhoneNumber": "2145555055",
    "NumberOfAttempts": 1,
    "LastCallTime": "2017-05-25 17:54:53-0500",
    "FirstName": "John",
    "LastName": "Doe",
    "Notes": null,
    "IntegrationData": "A67CH829",
    "SurveyResult": null,
    "CallResultCategory": "Live Answer",
    "CallStatus": "Completed",
    "TransferDuration": 0,
    "TransferCredits": 0.0,
    "IsTransferInitiated": false,
}

                            
                        

                
            

BroadcastSurveyResponse

Example

Property	Description
Integer _1	The number of *1 responses to the survey question.
Integer _2	The number of *2 responses to the survey question.
Integer _3	The number of *3 responses to the survey question.
Integer _4	The number of *4 responses to the survey question.
Integer _5	The number of *5 responses to the survey question.
Integer _6	The number of *6 responses to the survey question.
Integer _7	The number of *7 responses to the survey question.
Integer _8	The number of *8 responses to the survey question.
Integer _9	The number of *9 responses to the survey question.
Integer _0	The number of *0 responses to the survey question.

                
                                {
    "_1": 14,
    "_2": 10,
    "_3": 0,
    "_4": 0,
    "_5": 0,
    "_6": 0,
    "_7": 0,
    "_8": 0,
    "_9": 0,
    "_0": 0,
}

Contact

Example

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).
String PrimaryPhone	The primary phone number (required).
String SecondaryPhone	An optional secondary phone number.
String 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.
String 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.
String 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.
String TertiaryPhoneTextOptInStatus	The text opt-in status for the tertiary phone number.
String LastUpdated	The last time the contact was changed.
ArrayList Lists	The list of groups the contact is a member of.

                
                    
                            
                            
                                {
    "FirstName": "John",
    "LastName": "Doe",
    "PrimaryPhone": "2145551212",
    "SecondaryPhone": "",
    "TertiaryPhone": "",
    "Notes": "Away in December!",
    "PersonID": 4912484,
    "DoNotCallPrimaryPhone": false,
    "DoNotCallSecondaryPhone": false,
    "DoNotCallTertiaryPhone": false,
    "PrimaryPhoneTextOptInStatus": "",
    "SecondaryPhoneTextOptInStatus": "",
    "TertiaryPhoneTextOptInStatus": "",
    "LastUpdated": "2018-11-08 17:54:13.153-0600",
    "Lists": 
    [
        {
            "ListID": 3,
            "ListType": "User",
            "ListName": "Test",
            "ListDescription": "",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2018-09-27 13:57:38.323-0500",
            "RosterCount": 25000,
        },
        {
            "ListID": 5,
            "ListType": "User",
            "ListName": "From broadcast",
            "ListDescription": "Uploaded from broadcast",
            "SMSName": "",
            "IsAutoReplyOn": false,
            "AutoReplyMessage": "",
            "LastUpdated": "2018-08-20 14:32:49.217-0500",
            "RosterCount": 0,
        }
    ]
}

                            
                        

                
            

Feed

Example

Property	Description
Integer Size	The total number of items in the feed altogether.
ArrayList Items	One page of items in the feed.
String Previous	The link to the previous page of items in the feed. Null on the first page.
String Next	The link to the next page of items in the feed. Null on the last page.

                
                    
                            
                            
                                {
    "Size": 1,
    "Items": 
    [
        {
            "Uri": "/v1/broadcasts/23718",
            "UriBroadcastDetails": "/v1/broadcasts/23718/details",
            "BroadcastName": "Test Broadcast",
            "BroadcastType": "Announcement",
            "BroadcastStatus": "Complete",
            "CreatedDate": "2014-01-01 15:54:12-0600",
            "StartDate": "2014-01-01 15:54:13-0600",
            "CallerID": "9725551212",
            "CreditsUsed": 1.00,
            "PhoneNumberCount": 1,
            "TotalCompleted": 1,
            "RetryTimes": 1,
            "CallThrottle": 0,
            "LivePersonTotal": 1,
            "AnsweringMachineTotal": 0,
            "BusyNoAnswerTotal": 0,
            "InvalidNumberTotal": 0,
            "SurveyResponseTotal": 0,
            "SurveyResponses": null,
        }
    ],
    "Previous": null,
    "Next": "/broadcasts?StartDate~gte~2014-01-01&StartDate~lte~2014-01-02& BroadcastStatus=Completed&pagesize=10&page=2",
}

                            
                        

                
            

FileUpload

Example

Property	Description
String FileID	The unique resource ID for the file upload.
String Status	The file upload status.
String Created	The time the file upload was initiated.
Model FileStructure	The perceived structure of the file.
Model Summary	The summary result if the file upload.

                
                    
                            
                            
                                {
    "FileID": "73312_20181109141519.csv",
    "Status": "Completed",
    "Created": "2018-11-09 14:15:19.598-0600",
    "FileStructure": null,
    "Summary": 
    {
        "GoodRecordCount": 16,
        "BadRecordCount": 0,
        "DuplicateRecordCount": 0,
        "GoodFeedUri": "/v1/fileuploads/73312_20181109141519.csv/goodrecords",
        "BadFeedUri": "/v1/fileuploads/73312_20181109141519.csv/badrecords",
        "DuplicateFeedUri": "/v1/fileuploads/73312_20181109141519.csv/duplicaterecords",
        "ConflictedRecordCount": 0,
        "GoodContactCount": 16,
    }
}

                            
                        

                
            

FileUploadStructure

Example

Property	Description
Integer TabCount	The number of data sheets the file has.
ArrayList Tabs	The file's data sheets.

                
                    
                            
                            
                                {
    "TabCount": 1,
    "Tabs": 
    [
        {
            "Name": "Sheet1",
            "HasHeaderRow": false,
            "RowNumber": 3,
            "ColumnNumber": 4,
            "TotalContactCount": 3,
            "Phone1": 0,
            "Phone2": null,
            "Phone3": null,
            "FirstName": 1,
            "LastName": 2,
            "Notes": 3,
            "Rows": 
            [
                [
                    "9725551000",
                    "Fred",
                    "Jones",
                    "Note1"
                ],
                [
                    "9725551001",
                    "Mike",
                    "Smith",
                    "Note2"
                ],
                [
                    "9725551002",
                    "Mary",
                    "Doe",
                    ""
                ]
            ],
            "AreaCode1": null,
            "AreaCode2": null,
            "AreaCode3": null,
            "ListID": null,
            "ListName": null,
        }
    ]
}

                            
                        

                
            

FileUploadStructureTab

Example

Property	Description
String Name	The name of the data sheet.
Boolean HasHeaderRow	Whether the first row contains headers.
Integer RowNumber	The number of rows on the data sheet.
Integer ColumnNumber	The number of columns on the data sheet.
Integer TotalContactCount	The total number of contacts found on the data sheet.
Integer Phone1	The column index that contains the Primary Phone information. Zero based.
Integer Phone2	The column index that contains the Secondary Phone information. Zero based. Null if there is no such column.
Integer Phone3	The column index that contains the Tertiary Phone information. Zero based. Null if there is no such column.
Integer FirstName	The column index that contains the First Name information. Zero based. Null if there is no such column.
Integer LastName	The column index that contains the Last Name information. Zero based. Null if there is no such column.
Integer Notes	The column index that contains the Notes information. Zero based. Null if there is no such column.
ListArray Rows	A sample of the first few data rows.
String AreaCode1	The column index that contains the area code of the Primary Phone information. Zero based. Null if there is no such column.
String AreaCode2	The column index that contains the area code of the Secondary Phone information. Zero based. Null if there is no such column.
String AreaCode3	The column index that contains the area code of the Tertiary Phone information. Zero based. Null if there is no such column.
Integer ListID	The column index that contains the List ID information. Zero based. Null if there is no such column.
String ListName	The column index that contains the List Name information. Zero based. Null if there is no such column.

                
                    
                            
                            
                                {
    "Name": "Sheet1",
    "HasHeaderRow": false,
    "RowNumber": 3,
    "ColumnNumber": 4,
    "TotalContactCount": 3,
    "Phone1": 0,
    "Phone2": null,
    "Phone3": null,
    "FirstName": 1,
    "LastName": 2,
    "Notes": 3,
    "Rows": 
    [
        [
            "9725551000",
            "Fred",
            "Jones",
            "Note1"
        ],
        [
            "9725551001",
            "Mike",
            "Smith",
            "Note2"
        ],
        [
            "9725551002",
            "Mary",
            "Doe",
            ""
        ]
    ],
    "AreaCode1": null,
    "AreaCode2": null,
    "AreaCode3": null,
    "ListID": null,
    "ListName": null,
}

                            
                        

                
            

FileUploadSummary

Example

Property	Description
Integer GoodRecordCount	The number of records in the file upload that are in correct format.
Integer BadRecordCount	The 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.
Integer DuplicateRecordCount	The number of records that are in a correct format, but the phone number is already listed in the same file upload.
String GoodFeedUri	The link to the feed that pages through the correct file upload records.
String BadFeedUri	The link to the feed that pages through the incorrect file upload records.
String DuplicateFeedUri	The link to the feed that pages through the duplicate file upload records.
Integer ConflictedRecordCount	The number of records containing the same phone numbers that are already stored in contacts.
Integer GoodContactCount	One file upload record can contain up to three phone numbers. The GoodContactCount will give the number of good contacts in the file upload.

                
                                {
    "GoodRecordCount": 16,
    "BadRecordCount": 0,
    "DuplicateRecordCount": 0,
    "GoodFeedUri": "/v1/fileuploads/73312_20181109141519/goodrecords",
    "BadFeedUri": "/v1/fileuploads/73312_20181109141519/badrecords",
    "DuplicateFeedUri": "/v1/fileuploads/73312_20181109141519/duplicaterecords",
    "ConflictedRecordCount": 0,
    "GoodContactCount": 16,
}

List

Example

Property	Description
Integer ListID	The unique resource ID for the contact group.
String ListType	The type of the contact group.
String ListName	A short name of the contact group.
String ListDescription	A longer descrpition of the contact group.
String SMSName	Used for accounts set up with short code texting. When an SMSName is assigned to the contact group, people can opt in directly to the group by texting "join SMSName" to the short code.
Boolean IsAutoReplyOn	Used for accounts set up with short code texting. When 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.
String AutoReplyMessage	Used for accounts set up with short code texting. This 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.
String LastUpdated	The last time the contact group itself has been modified. It does not change upon contacts being added to or removed form the group.
Integer RosterCount	The contact group's membership count.

                
                                {
    "ListID": 5,
    "ListType": "User",
    "ListName": "Parents",
    "ListDescription": "Uploaded from broadcast",
    "SMSName": "",
    "IsAutoReplyOn": false,
    "AutoReplyMessage": "",
    "LastUpdated": "2018-11-09 13:51:44.5-0600",
    "RosterCount": 1,
}

MessageRecording

Example

Property	Description
String Uri	The link to self.
String PhoneNumber	The toll free number to call to record the voice message.
String MessageRecordingID	Enter this code when the toll free script prompts for the recording ID.
String Status	The recording status.

                
                                {
    "Uri": "/v1/broadcasts/58439/recording-instructions",
    "PhoneNumber": "866.284.4401",
    "MessageRecordingID": "134535",
    "Status": "RecordingComplete",
}

TextConversation

Example

Property	Description
Integer ConversationID	The unique resource ID for the conversation model.
Integer TextNumberID	The resource ID for the text number used in th conversation.
String PhoneNumber	The phone number contacted.
Integer TotalCount	The total number of messages in the conversation thread.
Integer UnreadCount	The total number of unread messages in the conversation thread.
Boolean IsDone	Whether the conversation was marked as 'Done' by a user.
Boolean IsAutoOptOut	Whether a reply message sent was detected as an intent to opt out of further messages.
String FirstName	The first name of the contact.
String LastName	The last name of the contact.
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.
Boolean OptedOut	Whether the contact has opted out of receiving text messages.
Boolean OptedIn	Whether the contact has explicitly opted in to receive text messages.
Model LastMessage	The last message sent on the conversation thread.
Model Views	The last time the conversation was viewed by a user.
Model TextPhoneNumber	Input only field. The toll free number or local number to initiate the conversation form.
Model Contacts	Input only field. Update FirstName, Lastname, Notes fields on the contacts specified with this feed.

                
                                {
    "ConversationID": 10228,
    "TextNumberID": 98615,
    "PhoneNumber": "2145555055",
    "IsDone": false,
    "IsAutoOptOut": false,
    "FirstName": "James",
    "LastName": "Polk",
    "Notes": null,
    "IntegrationData": "A67CH829",
    "TextPhoneNumber": "18338028132",
}

TextConversationView

Example

Property	Description
String Name	Name of the user.
String LastViewTime	The last timee the conversation was viewed by the user.

                
                                {
    "Name": "John Doe",
    "LastViewTime": "2018-11-15 09:49:20-0600",
}

TextMessage

Example

Property	Description
Integer TextMessageID	The unique resource ID for the text message.
String CreateTimestamp	The time the text message was sent.
Boolean IsInbound	Whether it is an inbound message sent to the user or an outbound message sent by the user.
String Message	The text of the message.
String Type	The type of the message.
String State	The sttaus of the text message.
Model Broadcast	If the message was part of a broadcast or a broadcast reply this field gives information about the broadcast.
Model Contact	The contact that the message was sent to or the contact that sent the message.
Model User	The user that sent the message.
Model Conversation	The conversation thread that the message belongs to.
ArrayList Mms	The Multi Media Messages attached to this message.

                
                    
                            
                            
                                {
    "TextMessageID": 466847,
    "CreateTimestamp": "2018-11-07 13:09:18-0600",
    "IsInbound": true,
    "Message": "Staging inbound",
    "Type": "Chat",
    "State": null,
    "Broadcast": null,
    "Contact": 
    {
        "FirstName": "James",
        "LastName": "Polk",
        "PrimaryPhone": "2145555055",
        "SecondaryPhone": null,
        "TertiaryPhone": null,
        "Notes": null,
        "PersonID": 0,
    },
    "User": null,
    "Conversation": null,
    "Mms": null,
    "TruncateIfExceedsLimit": false,
}

                            
                        

                
            

TextMmsData

Example

Property	Description
Integer ID	The unique ID for the MMS resource.
Integer TextMessageID	The resource ID for the text message containing the multi-media messages.
Integer CeaContentType	The content type.
String FileName	The original file name of the multi-media message.
String CeaUrlOriginal	A link to the content of the multi-media message.
String CeaUrlPreview	A link to a smaller sized thumbnail of the multi-media message.
Integer ExplicitStatus	The status of the message having explicit content.
Boolean IsExplicit	Whether the message was recognized having explicit content.
Boolean IsClean	Whether the message was recognized as not having explicit content.

                
                                {
    "ID": 155,
    "TextMessageID": 467499,
    "CeaContentType": 1,
    "FileName": "IMG_0735.jpg",
    "CeaUrlOriginal": "https://d3qkbrjvpe8d55.cloudfront.net/kg6buxk00",
    "CeaUrlPreview": "https://d3qkbrjvpe8d55.cloudfront.net/ha2qrmm4",
    "ExplicitStatus": 4,
    "IsExplicit": false,
    "IsClean": true,
}

TextNumber

Example

Property	Description
Integer TextNumberID	The text number's unique resource ID.
String TextPhoneNumber	The toll fee phone number.
String Name	A short name for the text number given by the user.
String Description	A longer description for the text number given by the user.
Integer UnreadCount	The number of unread messages on this text number.
Boolean IsDefault	Whether this is the default textnumber to use.
Boolean CanCreateBroadcast	Whether the text number can be used to create a text broadcast.
String FlatRateConversationStatus	Whether the text number is set up on the unlimited conversation plan.
String FlatRateSubscriptionEndDate	If the text number is set up on the unlimited conversation plan, when does the subscription plan renew.
Integer BroadcastCharacterCountMax	The maximum length a text message can be sent out as a broadcast on this text number.
Integer GroupChatCharacterCountMax	The maximum length a text message can be sent out as a group conversation message on this text number.
Integer ConversationCharacterCountMax	The maximum length a text message can be sent out as a conversation message on this text number.

                
                                {
    "TextNumberID": 98615,
    "TextPhoneNumber": "18005558132",
    "Name": null,
    "Description": null,
    "UnreadCount": 194,
    "IsDefault": false,
    "CanCreateBroadcast": true,
    "FlatRateConversationStatus": "Inactive",
    "FlatRateSubscriptionEndDate": null,
    "BroadcastCharacterCountMax": 320,
    "GroupChatCharacterCountMax": 320,
    "ConversationCharacterCountMax": 320,
}

TimeOfDay

Example

Property	Description
Integer Hour	The hour part of the time of day.
Integer Minute	The minutes part of the time of day.

                
                                {
    "Hour": 8,
    "Minute": 30,
}

TransferSettings

Example

Property	Description
Boolean IsTransfer	Whether the broadcast was set up for transfer and connect.
Integer TransferLines	The 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
String TransferNumber	The phone number the calls are transferred to upon request.
Float TransferCreditsUsed	The 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.

                
                                {
    "IsTransfer": true,
    "TransferLines": 1,
    "TransferNumber": "2142998560",
    "TransferCreditsUsed": 1.0,
}

User

Example

Property	Description
Integer UserID	The unique resource ID for the user.
String UserName	The Username for logging in to the call-em-all site.
String PinCode (R)	The Password for logging in to the call-em-all site.
String FirstName	The user's first name.
String LastName	The user's last name.
String Email	The user's email contact.
String Phone	The user's phone contact.
String CallerID	The default phone number the calls appear to be coming from.
Integer Retries	The default number of call retries attempted in case of busy tone or ring no answer. The default value is 1.
Integer MaxMessageLength	The default maximum voice message length in seconds that the user can use. The default value is 120.
Integer CallThrottle	The default call speed. It controls how many voice calls are being up at any given time.
Model StartTimeOfDay	The start of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Model StopTimeOfDay	The end of the user's default calling window. Calls will not be made outside of the calling window unless explicitly intructed.
Boolean ContinueOnNextDay	The default behavior on how to handle calls that could not be completed because of reaching the end of the calling window.
ArrayList CallingWindowDays	The list of days that calls are limited to. E.g. "Monday", "Tuesday". All days of the week if empty.
String State	The State the user resides in. The State determines the default time zone for the start time of the calls.
Model Permissions	The user permissions.

                
                    
                            
                            
                                {
    "UserID": 208867,
    "UserName": "apitest@cea",
    "FirstName": "Luke",
    "LastName": "Skywalker",
    "Email": "luke@galaxy.com",
    "Phone": "2027075000",
    "CallerID": "2027075000",
    "Retries": 1,
    "MaxMessageLength": 120,
    "CallThrottle": 10,
    "ContinueOnNextDay": true,
    "StartTimeOfDay": 
    {
        "Hour": 7,
        "Minute": 0,
    },
    "StopTimeOfDay": 
    {
        "Hour": 20,
        "Minute": 0,
    },
    "CallingWindowDays": 
    [
        "Sunday",
        "Monday",
        "Tuesday",
        "Wednesday",
        "Thursday",
        "Friday",
        "Saturday"
    ],
    "State": "TX",
    "Permissions": 
    {
        "CanSeeAllBroadcasts": true,
        "CanSeeAllRoster": true,
        "CanSeeAllAudio": true,
        "CanSeeGroupAudio": true,
    }
}

                            
                        

                
            

UserPermissions

Example

Property	Description
Boolean CanSeeAllBroadcasts	Whether the user can have access to all broadcasts on the account that other users created.
Boolean CanSeeAllRoster	Whether the user can have access to all contacts on the account that other users created.
Boolean CanSeeAllAudio	Whether the user can have access to all audio on the account that other users created.
Boolean CanSeeGroupAudio	Whether 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.

                
                                {
    "CanSeeAllBroadcasts": true,
    "CanSeeAllRoster": true,
    "CanSeeAllAudio": true,
    "CanSeeGroupAudio": false,
}

REST API Common Types

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.

Common Type: AudioRecordingStatus

The possible statuses exposed that an audio recording can take.

Name	Description
AwaitingRecording	The audio has not been recorded yet. It is waiting for recording.
RecordingComplete	The audio recording has been completed.

Common Type: BroadcastStatus

Throughout its lifetime from creation to completion the broadcast goes through a serious of statuses that we use for internal processing. These statuses are more granual than you might care for. Please work off of the BroadcastStatusCategory values instead (see below).

Common Type: BroadcastStatusCategory

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.

Name	Description
NeedsMessage	If 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.
Expired	If 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.
Processing	After 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.
Rejected	If during the proessing of the broadcast there was some kind of an issue the broadcast moves into a Rejected status. It could be because of bad audio qulaity 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.
Scheduled	When a broadcast is all set up and just waiting for the StartTime to pass to start sending messages it is showing in Scheduled status.
Broadcasting	A broadcast is in Broadcasting status while the messages are being sent out.
Completed	A broadcast moves to a final Completed status, after Broadcasting when all the messages have been sent out or the broadcast was canceled.

Common Type: BroadcastType

The broadcast type describes what type of messages the broadcast is sending out. When creating a combination broadcast via the API - that is a combination of text and voice broadcast, you can combine these broadcast types to create a combination type. The result of a combination broadcast is two separate broadcasts: one for the text and one for the voice portion.

Name	Description
Announcement	It 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...
Survey	The 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...
SMS	SMS is a text broadcast type that sends a text message to the broadcast's recipients.
SMSAndAnnouncement	Broadcast type for creating a combination broadcast. Each recipient will receive both a voice and a text message.
SMSAndSurvey	Broadcast type for creating a combination broadcast. Each recipient will receive both a survey and a text message.
SMSOrAnnouncement	Broadcast type for creating a combination broadcast. The textable phone numbers will receive a text message, while the remaining numbers receive a voice message.
SMSOrSurvey	Broadcast type for creating a combination broadcast. The textable phone numbers will receive a text message, while the remaining numbers receive a voice survey message.

Common Type: CallResultCategory

Although a call's actual result might be more granual, we have created a grouping of these results into categories that best describe a call's outcome.

Name	Description
LiveAnswer	The call has been initiated to the phone number and someone picked up the phone.
LiveTransfer	During a transfer and connect broadcast someone picked up the phone and after listening to the message initiated a call transfer.
Voicemail	The call has been initiated to the phone number and a message was left on an answering machine.
BusyNa	The dial to the phone number encountered a busy signal without anyone answering or being sent to vociemail.
Invalid	This was not a valid phone number to call.
NotCompleted	The call was not completed. It could be because the broadcast was rejected, canceled or the contact was on the do not call list.

Common Type: CallStatus

The possible statuses each voice call in a broadcast can take.

Name	Description
NotCalled	The phone number in the broadcast has not been called yet.
Calling	The call is being placed to the phone numnber at this time.
CallCompleted	The 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.

Common Type: Email

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-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)\Z

Common Type: FileUploadStatus

The status of a file upload progress.

Name	Description
InProgress	If 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.
Complete	The file upload has successfully completed.
Error	There was an error during the file upload process.

Common Type: FlatRateConversationStatus

Toll free text numbers can be set up on an unlimited conversations plan to be billed for a monthly flat rate. The flat rate conversation status indicates the status of this setup.

Name	Description
Active	The toll free text number is on an active unlimited conversation plan.
Inactive	The toll free text number is not on an unlimited conversation plan. Each conversation message is funded by credits.
CancelPending	The toll free text number is still on an unlimited conversation plan, however the plan is not going to renew after the subscription end date has been reached.
BillingProblem	The toll free text number used to be on an unlimited conversation plan, but renewing the plan on the subscription end date has failed. The toll free text number cannot be used for sending conversation messages in this state.

Common Type: ListType

The type of a contact list.

Name	Description
System	The predefined contact lists: Everyone, Unfiled, Deleted - have a System list type.
User	All other contact lists created by users or created via the API have a User list type.

Common Type: PhoneNumber

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.

Common Type: PIN / Password

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}$/.

Common Type: TextMessageState

These are all the different states a text message can be categorized in for our own internal processing. It is less useful for an API client to use them in this format. We will need categorize them into less granual types that can be better handled by a client.

Name	Description
NeedsSending	The text message has not been sent yet.
SentToAggregator	The text message has been sent to the text carrier.
RejectedByAggregator	The text message could not be sent sent to the carrier.
FailedAndResent	If a message in Rejected by Aggregator state gets chosen to be resent, the orignal message's state changes to Failed and Resent and a copy of the message is being added for the retry.
UnsentBecauseBcCanceled	The text message has not been sent because the broadcast was canceled.
UnsentBecauseBcRejected	The text message has not been sent because the broadcast was rejected due to content.
UnsentBecauseOptedOut	The text message has not been sent because the recipient has opted out from receiving text messages.
UnsentBecauseBlacklisted	The text message has not been sent because the phone number has recently changed ownership.
UnsentBecauseAttemptsExceeded	The attempt to deliver the text message to the carrier has failed exceeding the number of retries.

Common Type: TextMessageType

These are all the different types a text message can be categorized for our own internal processing. It is less useful for an API client in this format. We will need categorize them into less granual types that can be better interpreted and processed by a client.

Name	Description
Broadcast	The text message was sent to a recipient as part of a mass text broadcast.
Chat	The text message was sent to a recipient as a conversation message.
GroupSms	The text message was sent to a recipient as part of a group conversation message.
BroadcastReply	The inbound text was received from a recipient as a reply to an earlier broadcast message.
JoinEveryone	An inbound text message opting in to receive messages from the account.
JoinGroup	An inbound text message opting in to receive messages from the account and being added to a contact group.
JoinConfirmation	A text message sent to the recipient after a join request confirming that they have opted in to receiving messages from the account.
Stop	A stop opt-out message from a phone number.
AutoOptOut	An inbound text message interpreted as an opt-out message from a phone number.
OptOutConfirmation	A text message sent to the recipient after an opt-out request confirming that they have opted out.
Unstop	A text message received from a recipient to opt back-in receiving text messages again after a previous opt-out message.
OptOutConfirmation	A text message sent to the recipient after an unstop message confirming that they have opted back in to receive text messages again.
BroadcastLaunch	A text message that initiated sending a mass text broadcast from a phone.
BcLaunchConfirmation	A text message sent confirming that a mass text broadcast was created from a text received from the phone.
BcLaunchError	A text message sent in response to failing to create a mass text broadcast initated from the phone.
NotificationsText	A notification text sent when receiving new unread messages to a toll free text number.

Common Type: TextOptInStatus

For toll free texting, recipients do not need to explicitly give permission to an account to send them text messages by opting in from their phone. A recipient might still opt-out or opt-in to receive your messages. This status indicatesthe phone number's owner's intent.

Name	Description
NoAuthRecordFound	There is no opt-in or opt-out information associated with this phone number.
OptedOut	This phone number has opted out of receiving text messages.
SMSInviteSent	There has been an opt-in invitation sent to the phone number, but no reply has been received yet.
AuthorizationAccepted	This 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.

Common Type: TextResultCategory

Although the actual result of sending a text might be more granual, we have created a grouping of these results into categories that best describe the outcome.

Name	Description
Sent	The text message was successfully sent to the carrier.
Delivered	The text message was successfully sent to the carrier and we have received a confirmation about the carrier delivering the message to the phone.
NotSent	The text message has not been sent yet or the broadcast has been canceled.
OptedOut	The text message was not sent because the phone number has opted out of receiveng text messages.
Failed	The text message failed to reach the phone.
Invalid	The phone number was invalid and the text message could not be sent to the phone.

Common Type: TextStatus

The sending status of a text message.

Name	Description
NotComplete	The text message has not been sent out yet.
Completed	The 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 receiveng text messages.

Common Type: Token

A Token is a Globally Unique Identifier (GUID). For example: d35ba23e-aba6-46a4-8640-62ce628af4cf

Common Type: Username

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._~!@#$%^&*-\/+'?]+$.

Single Sign On Integration (SSO)

Integrations that use SSO will easily be able to incorporate all Call-Em-All functionality into their website or application. Developers can choose to open up the Call-Em-All app in a browser window, or in an iframe inside their application. With SSO, your user is already logged in to Call-Em-All - giving them access to complete the tasks they need.

SSO integrations are done using the Call-Em-All REST API. Developers will call an endpoint in order to receive a temporary token that can be used to open up the Call-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.

Provisioning

Every REST API request requires an authorization token included in the header that identifies the integration and the user that is making the call to Call-Em-All. That token can be obtained programmatically and stored on the user record in your system. The expiration time on the token is customizable.

To obtain the authorization token for the user, you will need to pass in their Call-Em-All username and password. Call-Em-All recommends prompting the user for their Call-Em-All login information and not storing it as it can be changed any time on the Call-Em-All website. Please see the Log In User endpoint for the implementation details.

The provisioning process is also the best place for adding web-hook notifications for the user for events your integration would like to listen to. Please refer to the Web Hooks documentation to get more information.

Create Broadcast

Your client application determines the contacts to be messaged.

Pass in the contacts via the REST API receiving a temporary token.

Request

POST /draftbroadcasts

                
                    
                            
                            
                                {
    "Contacts": 
    [
        {
            "FirstName": "Jane",
            "LastName": "Jones",
            "PrimaryPhone": "(972)764-3333",
            "SecondaryPhone": "2141111920",
            "TertiaryPhone": "(972)764-4444",
            "Notes": "Officer",
            "IntegrationData": "A67CH829",
        }, 
        { 
            "FirstName": "Mary",
            "LastName": "Gibson",
            "PrimaryPhone": "2141111920",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "A56CJ829",
        },
        { 
            "FirstName": "Joe",
            "LastName": "Smith",
            "PrimaryPhone": "2144021234",
            "SecondaryPhone": "",
            "TertiaryPhone": "",
            "Notes": "",
            "IntegrationData": "A21CP214",
        }
    ]
}

                            
                        

                
            

Response

                
                    
                            
                            
                                {
    "Created": "2014-04-25 15:47:26-0500",
    "SingleSignOnToken": "2c683f59-a797-4de1-8868-b8e172720342",
    "SingleSignOnUrl": "https://staging-app.call-em-all.com/sso.aspx?TemporaryKey=2c683f59-a797-4de1-8868-b8e172720342",
    "FailedContacts": 
    [
        {
            "ErrorCode": 203,
            "ErrorMessage": "Duplicate phone number: 2141111920",
            "Contact": 
            {
                "FirstName": "Mary",
                "LastName": "Gibson",
                "PrimaryPhone": "2141111920",
                "SecondaryPhone": "",
                "TertiaryPhone": "",
                "Notes": "",
                "IntegrationData": "A56CJ829",
            }
        }
    ]
}

                            
                        

                
            

In the next few seconds, using the SingleSignOnUrl your application will be able to open up the Call-Em-All website in a new browser window or frame at:
https://app.call-em-all.com/sso.aspx?TemporaryKey=....
or
https://staging-app.call-em-all.com/sso.aspx?TemporaryKey=....
Showing the familiar create broadcast page with the contacts to call already populated.

Text Conversations

Using the Call-Em-All Rest-API you can open up the Conversations page in an IFrame in your client application or in a separate browser. You can choose to show all the text numbers (toll free numbers) that the user has access to and all the ongoing chat conversations on those text numbers.

You can also choose to only show the message thread of a single conversation between one toll free number and one recipient. (That is the right most column in the full conversation picture attached above.)

Screenshot of right column of conversations page

To show conversations via Single-Sign-On:

Request a Single Sign On token to see conversation. You can optionally send in a TextNumber and a PhoneNumber to be defaulted to. When omitted all available text numbers and phone numbers will be shown.

Request

POST /single-sign-on/conversations

                
                                {
    "TextNumber": “18338028132”,
    "PhoneNumber": “2145551212”,
}

Response

                
                                {
    "Created": "2014-04-25 15:47:26-0500",
    "Expires": "2014-04-25 15:48:26-0500",
    "Token": "2c683f59-a797-4de1-8868-b8e172720342",
    "Url": "https://staging-app.call-em-all.com/sso.aspx?token=2c683f59-a797-4de1-8868-b8e172720342",
}

In the next few seconds your application will be able to open up the Call-Em-All website in a new browser window or frame using the link that the Url field of the response specifies.

The link will show only the conversation messages thread between the text-number and the phone number if both were specified in the single-sign-on request. The link will show the entire conversation page if the phone numbers were omitted from the single-sign-on request.

Call-Em-All REST API

Everything you need to add Call-Em-All broadcasting to your application.

Contents

Introduction

Account Requirements

Setting Up Your Integration

User Setup

The REST API

API Requests

Authentication

Response

Errors

Collections/Feeds

Feed query parameters

Example

Search and Sort

Example

Request Rate Limit

REST API Endpoints

Account

Create User

Example

Update User Settings

Example

Broadcasts

Create Broadcast

Example

Query Broadcasts

Example

Get Broadcast

Example

Get Broadcast

Example

Broadcasts Details

Query Broadcast Details (Call)

Example

Query Broadcast Details (Text)

Example

Conversations

Get Conversation

Example

Contacts

Query Contacts

Example

Get Contact

Example

Create Contact

Example

Delete Contact

Example

Delete Contacts

Example

Contact Lists

Query Contact Lists

Example

Get Contact List

Example

Get Everyone List

Example

Create Contact List

Example

Delete Contact List

Example

Contact List Membership

Query List Contacts

Example

Remove a Contact from List

Example

Remove Contacts from List

Example

Remove Contacts from the Deleted List

Example

User

Log in User

Example

REST API Models

Audio

Example

Broadcast

Example