CATI getCATIContacts
Contents
CATI_getCATIContacts
This script is used to get information of Cati contact with specified RPQ Id. If the RPQId is not input, you will need the RPQ context
Syntax
array CATI_getCATIContacts([number RPQId])
Arguments
RPQId : resource project questionnaire id (optional)
Return type
Array
|
Index |
Data type |
Value |
|
OBJECT_TYPE |
number |
|
|
CATI_CONTACT_ID |
number |
Id of Cati contact |
|
CATI_CONTACT_INTERVIEWER_USER_RESOURCE_ID |
number |
The interviewer resource id of Cati contact |
|
CATI_CONTACT_START_DATE |
array datetime |
The start date of Cati contact |
|
CATI_CONTACT_END_DATE |
array datetime |
The end date of Cati contact |
|
CATI_CONTACT_OUTCOME_STATUS_ID |
number |
Status of Cati contact |
|
CATI_CONTACT_OUTCOME_STATUS_AS_TEXT |
string (read only) |
The text of contact_status_id |
|
CATI_CONTACT_DESCRIPTION |
string |
Description of Cati contact |
| CATI_CONTACT_OUTCOME_STATUS_TYPE | number | Success = 1
Failure = 2 Meeting = 3 Retry = 4 |
| CATI_CONTACT_OUTCOME_IS_AUTO | bool | |
| CATI_CONTACT_OUTCOME_IS_OUTOFQUOTA | bool | |
| CATI_CONTACT_OUTCOME_ASTERISK_MAPPING | number | *mapping |
| CATI_CONTACT_DIAL_DURATION_IN_MS | number | The amount of time the phone rang before pickup or giveup |
Mapping:
2: Busy (Successful call to interviewer but respondent is busy)
3: Noanswer (Successful call to interviewer but respondent Noanswer)
4: Cancel (Successful call to interviewer but he/she hang up before successful calling to respondent)
5: Congestion (Congestion can't make any call)
6: InvalidNumber (Successful call to interviewer but invalid number)
7: ChanUnavail (Device of interviewer is not connected)
8: DontCall (The interviewer hang up the call from Asterisk)
10: ContactLimitReached (rpq.TimesCalled >= _currentPQ.ContactLimit)
12: AnsweringMachine (When the number is picked up so fast, it cannot be a human)
13: Dropped (When the predictive dialer drops a call)
Example
array a = CATI_getCATIContacts(89716960);
print(a);
// {{29,14358155,9960805,{2010,11,11,3,34,21,600,45,40},{2010,11,11,3,36,37,200,45,40},12939,Busy,Busy || retry on (03:51 - interviewer's time) (03:51 - respondent's time)},{29,14358161,9960805,{2010,11,11,3,53,22,0,45,40},{2010,11,11,4,26,39,800,45,40},12939,Busy,Busy || retry on (04:41 - interviewer's time) (04:41 - respondent's time)}}
Availability
Version 5.8
