This API document covers how an agent of the party that is responsible for the offer can retrieve a list of contact information of the people on calls that agreed to opt-in terms. All the interfaces require the requesting party to know the offer id and the offer security token. These were provided to them during the setup of the offer, please contact customer service if you have lost or misplaced them.
There are two ways to retrieve data about an offer that was presented, first by date range, second by specific call id. Although each has specific parameters they share the following query parameters.
|offer_id||The Id number given to you that related to your offer|
|offer_token||The security string related to the offer. It is paired with the offer_id and is unique to each offer|
|type||(OPTIONAL)The output is by default a csv file, if type is specified and has a value of XML it will wrap the output as xml|
Use this URL to retrieve the caller information by supplying a from date/time and to date/time. In addition to the above parameters you need to specify for following parameters. The selection of calls analyzed are calls that ended at or newer that dateFrom up to but not including dateTo.
|dateFrom||Date and time to start selection from. Time stamp should be formatted as YYYY- MM-DD HH:MM:SS|
|dateTo||Date and time to end selection. Time stamp should be formatted as YYYY-MM- DD HH:MM:SS|
Use this URL to retrieve the caller information by supplying specific call UID. In addition to the shared parameters above you must also specify:
|call||UID of the call to process|
Any successful query will return a list of caller with the following information. The format of the resulting data by default is csv, if type is supplied and has a value of XML then the output is an xml document.
|customerEmail||Email(s) of the MaestroConference customer|
|callName||Name of the call this record came from|
|callTime||Start time of the call|
|conferenceEmail||Email(s) of the conference associated with the call|
|callUID||UID of the call that this caller participated in|
|callerUID||UID of the caller in that call|
|ANI||Caller id of the caller|
|name||Name of the caller if supplied|
|Email of the caller if supplied|
|affiliate||Affiliate code of the host the is providing the callers|