Security
| API | Description |
|---|---|
| POST api/Security/Login |
Creates a new session token for the specified user |
| GET api/Security/RequestReusableToken/{SessionToken} |
Requests a reusable token to allow the user to log in on in the future with that token and not their username and password |
| POST api/Security/LoginWithReusableToken |
Creates a new session token based off of the reusable token |
| POST api/Security/VerifyReusableToken |
Checks a reusable token without creating a new session |
| GET api/Security/Logout/{SessionToken} |
Marks a session token as expired and ends the user's session |
| DELETE api/Security/Logout/{SessionToken} |
Marks a session token as expired and ends the user's session |
Company
| API | Description |
|---|---|
| GET api/Company/GetHeaders/{SessionToken} |
Gets a list of active headers (From numbers) for the current user's company |
| GET api/Company/GetBrands/{SessionToken} |
Gets a list of brands for the current user's company |
User
| API | Description |
|---|---|
| GET api/Users/GetFolders/{SessionToken} |
Gets a list of folders for the current user |
| GET api/Users/GetFoldersBasic/{SessionToken} |
Gets a list of folders for the current user |
| GET api/Users/GetCurrentUserInfo/{SessionToken} |
Gets the details of the current user |
Message
| API | Description |
|---|---|
| POST api/Messages/SendInstantMessage |
Sends an instant message to the specified phone number. User must have Send Message permissions. |
| GET api/Messages/GetAllInboundMessages/{SessionToken} |
Gets a list of inbound messages associated with the user's company |
| GET api/Messages/GetInboundMessagesFromDate/{SessionToken}?DateFrom={DateFrom} |
Gets a list of inbound messages associated with the user's company since the specified date |
| GET api/Messages/GetInboundMessages/{SessionToken} |
Gets a list of inbound messages associated with the user's company since midnight the preceeding day |
| GET api/Messages/GetConversation/{SessionToken}/{PhoneNumber} |
Gets a conversation view of a number associated with the user's conversation |
| POST api/Messages/SendTwoFactorToken |
Sends an instant message to the specified phone number and generates a two factor authentication code. User must have Send Message permissions. |
TextIn
| API | Description |
|---|---|
| GET api/TextIn/GetAllTextIns/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted in |
| GET api/TextIn/GetTextInsFromDate/{SessionToken}?DateFrom={DateFrom} |
Gets a list of phone numbers associated with the user's company that have texted in since the specified DATe |
| GET api/TextIn/GetTextIns/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted in since midnight the preceeding day |
| GET api/TextIn/GetContacts/{SessionToken}/{TextInID}?DateFrom={DateFrom}&DateTo={DateTo} |
Retrieves a list of contacts who texted in with the specified Text-In between the two times defined. Time difference is limited to one week |
Status
| API | Description |
|---|---|
| GET api/Status/GetAllStops/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted STOP |
| GET api/Status/GetStopsFromDate/{SessionToken}?DateFrom={DateFrom} |
Gets a list of phone numbers associated with the user's company that have texted STOP since the specified date |
| GET api/Status/GetStops/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted STOP since midnight the preceeding day |
| GET api/Status/GetAllReinstates/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted START |
| GET api/Status/GetReinstatesFromDate/{SessionToken}?DateFrom={DateFrom} |
Gets a list of phone numbers associated with the user's company that have texted START since the specified date |
| GET api/Status/GetReinstates/{SessionToken} |
Gets a list of phone numbers associated with the user's company that have texted START since midnight the preceeding day |
| GET api/status/getrecentfails/{SessionToken}?DateFrom={DateFrom} |
Gets failed numbers from recent campaigns where they have failed at least 3 times. |
PhoneList
| API | Description |
|---|---|
| POST api/Phonelists/CreateList |
Creates a blank phone list |
| POST api/Phonelists/AddSingleEntry |
Adds an entry to a phone list |
| POST api/Phonelists/AddMultipleEntries |
Adds multiple entries to a phone list |
| GET api/Phonelists/GetLists/{SessionToken}/{Folder} |
Returns the phone lists in the specified folder. If no folder is specified, returns phone lists in the user's root folder. |
| GET api/Phonelists/GetLists/{SessionToken}?Folder={Folder} |
Returns the phone lists in the specified folder. If no folder is specified, returns phone lists in the user's root folder. |
| GET api/Phonelists/GetList/{SessionToken}/{List} |
Returns information on the phone list |
| GET api/Phonelists/GetNumbers/{SessionToken}/{List} |
Returns a list of numbers in the phone list |
| GET api/Phonelists/GetNumberDetail/{SessionToken}/{List}/{PhoneNumber} |
Returns details of a number in the phone list |
| GET api/Phonelists/GetPreviousNumber/{SessionToken}/{List}/{PhoneNumber} |
Returns the previous number in the phone list |
| GET api/Phonelists/GetNextNumber/{SessionToken}/{List}/{PhoneNumber} |
Returns the next number in the phone list |
Test
| API | Description |
|---|---|
| GET api/Test/{SessionToken} |
Returns a simple string and exposes all possible return types |
| GET api/Foo?Bar={Bar} |
Does nothing |
| POST api/Foo?Bar={Bar} |
Does nothing |
Campaign
| API | Description |
|---|---|
| POST api/Campaigns/CreateCampaign |
Creates a new campaign |
| POST api/Campaigns/LinkCampaignAndPhonelist |
Links a campaign and phonelist |
| DELETE api/Campaigns/UnlinkCampaignAndPhonelist |
Unlinks a campaign and phonelist |
| POST api/Campaigns/LaunchCampaign |
Sets the campaign to launch |
| POST api/Campaigns/StopCampaign |
Sets the campaign to not launch |