CATI getCATIContacts

From Catglobe Wiki
Revision as of 05:05, 19 April 2018 by Nguyenduyan (talk | contribs) (CATI_getCATIContacts)
Jump to: navigation, search



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,47565440,4551138,{2018,4,19,3,4,42,600,16,65},{2018,4,19,3,6,58,500,16,65},12403,Busy,Busy || retry on (Apr 19, 10:36 - interviewer's time) (Apr 19, 03:36 - respondent's time),4,True,False,2,90},{29,47565446,4551138,{2018,4,19,3,51,41,400,16,65},{2018,4,19,3,51,59,300,16,65},12399,Connection reached,Connection reached,1,False,False,0,90}}

Availability

Version 5.8