|
|
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
Add a new user to the account.
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
|
{ "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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
{ "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
Grant permission to broadcasts for the user on the account.
|
PUT /v1/account/users/{:id}
|
|
PUT /v1/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. |
|
1
2
3
4
5
6
|
{ "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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
{ "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
Create a new voice broadcast using an existing audio from the message library sending it to a 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
Create a voice broadcast from an existing audio from the library.
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
{ "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. |
|
1
2
3
4
5
|
{ "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 a list of broadcasts that have been completed.
|
|
GET /v1/broadcasts?BroadcastStatus=Completed
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Broadcasts in the feed altogether. |
ArrayList Items
|
One page of Broadcasts in the feed. |
String Previous
|
The link to the previous page of Broadcasts in the feed. Null on the first page. |
String Next
|
The link to the next page of Broadcasts in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
{ "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 a call broadcast by its ID.
|
|
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
{ "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 a text broadcast by its ID.
|
|
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
|
{ "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 the broadcast results for a completed voice broadcast.
|
GET /v1/broadcasts/{:id}/details
|
|
GET /v1/broadcasts/39609/details
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Broadcast Details in the feed altogether. |
ArrayList Items
|
One page of Broadcast Details in the feed. |
String Previous
|
The link to the previous page of Broadcast Details in the feed. Null on the first page. |
String Next
|
The link to the next page of Broadcast Details in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
{ "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 the broadcast results for a completed text broadcast.
|
GET /v1/broadcasts/{:id}/details
|
|
GET /v1/broadcasts/23718/details
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Broadcast Details in the feed altogether. |
ArrayList Items
|
One page of Broadcast Details in the feed. |
String Previous
|
The link to the previous page of Broadcast Details in the feed. Null on the first page. |
String Next
|
The link to the next page of Broadcast Details in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
{ "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
Look up a conversation.
|
GET /v1/conversations/single
|
|
GET /v1/conversations/single?textphonenumber=18338028132&phonenumber=2145555055
|
|
|
|
Response 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. |
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. |
Model TextPhoneNumber
|
Input only field. The toll free number or local number to initiate the conversation form. |
|
1
2
3
4
5
6
7
8
9
10
11
|
{ "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 all contacts containing the string 214.
|
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Contacts in the feed altogether. |
ArrayList Items
|
One page of Contacts in the feed. |
String Previous
|
The link to the previous page of Contacts in the feed. Null on the first page. |
String Next
|
The link to the next page of Contacts in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
{ "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 a single contact.
|
|
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
|
{ "Uri": "/contacts/4947403", "FirstName": "Bob", "LastName": "Lilly", "PrimaryPhone": "2145554846", "SecondaryPhone": "", "TertiaryPhone": "", "Notes": "", }
|
|
Create Contact
Create a contact in the Everyone list.
|
Example
Create a new contact.
|
|
|
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. |
|
1
2
3
4
5
6
|
{ "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. |
|
1
2
3
4
5
6
7
8
9
10
|
{ "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 a single contact.
|
DELETE /v1/contacts/{:id}
|
|
DELETE /v1/contacts/4947403
|
|
|
|
|
|
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 all contacts.
|
|
|
|
|
|
|
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 all contact lists.
|
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Lists in the feed altogether. |
ArrayList Items
|
One page of Lists in the feed. |
String Previous
|
The link to the previous page of Lists in the feed. Null on the first page. |
String Next
|
The link to the next page of Lists in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
{ "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 a single contact list.
|
|
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
|
{ "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 the everyone contact list.
|
|
|
|
|
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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
|
{ "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
Create a new contact list.
|
|
|
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. |
|
1
2
3
4
|
{ "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. |
|
1
2
3
4
5
6
7
8
9
10
11
12
|
{ "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 a single list.
|
|
|
|
|
|
|
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 all contacts from a list.
|
GET /v1/lists/{:id}/contacts
|
|
GET /v1/lists/34/contacts
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Contacts in the feed altogether. |
ArrayList Items
|
One page of Contacts in the feed. |
String Previous
|
The link to the previous page of Contacts in the feed. Null on the first page. |
String Next
|
The link to the next page of Contacts in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
{ "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
Remove a contact from a contact list.
|
DELETE /v1/lists/{:id}/contacts/{:contactid}
|
|
DELETE /v1/lists/34/contacts/4951360
|
|
|
|
|
|
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
Remove all contacts from a list.
|
DELETE /v1/lists/{:id}/contacts
|
|
DELETE /v1/lists/34/contacts
|
|
|
|
|
|
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
Remove all contacts from the Deleted foldert.
|
DELETE /v1/lists/deleted/contacts
|
|
DELETE /v1/lists/deleted/contacts
|
|
|
|
|
|
Opt Outs
|
Query Opt Outs
List or search all of the opted-out phone numbers within an account. Query parameters listed below can be used to filter and sort the result. The query returns a feed of OptOut models. Use the PageSize and Page query parameters or the Next link returned in the feed to retrieve all records.
|
Example
Get all opt-outs starting from a date.
|
|
GET /v1/optouts?date-from=2020-10-01
|
|
|
|
Response Property |
Description |
Integer Size
|
The total number of Opt-outs in the feed altogether. |
ArrayList Items
|
One page of Opt-outs in the feed. |
String Previous
|
The link to the previous page of Opt-outs in the feed. Null on the first page. |
String Next
|
The link to the next page of Opt-outs in the feed. Null on the last page. |
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
{ "Size": 2, "Items": [ { "FirstName": "Jack", "LastName": "Black", "PhoneNumber": "2145551234", "Notes": "", "OptOutDate": "2016-07-14 16:18:47-0500, "DoNotCall": true, "DoNotText": false, "GlobalOptOut": false", }, { "FirstName": "", "LastName": "", "PhoneNumber": "2145559999", "Notes": "", "OptOutDate": "2016-07-15 09:11:34-0500, "DoNotCall": false, "DoNotText": true, "GlobalOptOut": false", } ], "Previous": null, "Next": null, }
|
|
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
Log in the user.
|
|
|
Request Property |
Description |
String UserName
(R)
|
Username |
String PinCode
(R)
|
Password |
|
1
2
3
4
|
{ "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. |
|
1
2
3
4
|
{ "UserID": 73312, "AuthToken": "00000000-0000-0000-0000-000000000000", }
|
|