POST Recordings
Allows a call/phone service provider to send call information and recordings location data to the PowerChoice application.
Request Information
URI Parameters
None.
Body Parameters
RecordingsModel| Name | Description | Type | Additional information |
|---|---|---|---|
| PhoneProvider |
The name of the Telephone/Dialer System provider |
string |
None. |
| CallDate |
The datetime of the call. Please format as MM/DD/YYYY HH:MM |
date |
None. |
| PhoneNumberDialed |
The phone number that was dialed. Only 10-digit numeric is acceptable |
string |
None. |
| AgentFullName |
The name of our agent/station that made the call |
string |
None. |
| CampaignID |
The campaign ID number or value |
string |
None. |
| VendorLeadCode |
The vendor lead code. |
string |
None. |
| SourceID |
The source id |
string |
None. |
| ListID |
The list id |
string |
None. |
| Comments |
Any comments the agent made. |
string |
None. |
| LengthInSeconds |
The call duration in seconds |
integer |
None. |
| UserGroup |
The user/agent/caller group name, if available |
string |
None. |
| LeadID |
The lead id number |
integer |
None. |
| ListName |
The lead list name |
string |
None. |
| StatusCode |
A coded status of the call's disposition |
string |
None. |
| StatusName |
A more verbose description of the status code |
string |
None. |
| RecordingID |
If a call/recording took place, it's id# |
string |
None. |
| RecordingFilename |
If a call/recording took place, it's filename, e.g. somefilename123456789.mp3 |
string |
None. |
| RecordingLocation |
The URI location of the recording file that we may use to download/access the file, e.g. https://somehost.com/recordings/somefilename123456789.mp3 |
string |
None. |
Request Formats
application/json, text/json
{
"PhoneProvider": "sample string 1",
"CallDate": "2025-12-13T23:55:28.4476668-06:00",
"PhoneNumberDialed": "sample string 3",
"AgentFullName": "sample string 4",
"CampaignID": "sample string 5",
"VendorLeadCode": "sample string 6",
"SourceID": "sample string 7",
"ListID": "sample string 8",
"Comments": "sample string 9",
"LengthInSeconds": 10,
"UserGroup": "sample string 11",
"LeadID": 12,
"ListName": "sample string 13",
"StatusCode": "sample string 14",
"StatusName": "sample string 15",
"RecordingID": "sample string 16",
"RecordingFilename": "sample string 17",
"RecordingLocation": "sample string 18"
}
application/xml, text/xml
<RecordingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <AgentFullName>sample string 4</AgentFullName> <CallDate>2025-12-13T23:55:28.4476668-06:00</CallDate> <CampaignID>sample string 5</CampaignID> <Comments>sample string 9</Comments> <LeadID>12</LeadID> <LengthInSeconds>10</LengthInSeconds> <ListID>sample string 8</ListID> <ListName>sample string 13</ListName> <PhoneNumberDialed>sample string 3</PhoneNumberDialed> <PhoneProvider>sample string 1</PhoneProvider> <RecordingFilename>sample string 17</RecordingFilename> <RecordingID>sample string 16</RecordingID> <RecordingLocation>sample string 18</RecordingLocation> <SourceID>sample string 7</SourceID> <StatusCode>sample string 14</StatusCode> <StatusName>sample string 15</StatusName> <UserGroup>sample string 11</UserGroup> <VendorLeadCode>sample string 6</VendorLeadCode> </RecordingsModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
RecordingsResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| WasSuccessful | boolean |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
{
"WasSuccessful": true,
"Message": "sample string 2"
}
application/xml, text/xml
<RecordingsModel.RecordingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <Message>sample string 2</Message> <WasSuccessful>true</WasSuccessful> </RecordingsModel.RecordingsResponse>