CATI getCATIContacts: Difference between revisions

Revision as of 09:55, 17 April 2018

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

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

@@ Line 18: / Line 18: @@
 Array
-{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="651" border="1" cellpadding="2"
+{| class="tableintopic" style="border-collapse: collapse; border: 1px solid #010101" width="651" cellpadding="2" border="1"
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" bgcolor="#BFBFBF" |
 '''Index'''
@@ Line 26: / Line 26: @@
 | style="border: 1px solid #010101" width="195" bgcolor="#BFBFBF" |
 ''' Value'''
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 OBJECT_TYPE
@@ Line 33: / Line 33: @@
 | style="border: 1px solid #010101" width="195" |
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_ID
@@ Line 40: / Line 40: @@
 | style="border: 1px solid #010101" width="195" |
 Id of Cati contact
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_INTERVIEWER_USER_RESOURCE_ID
@@ Line 47: / Line 47: @@
 | style="border: 1px solid #010101" width="195" |
 The interviewer resource id of Cati contact
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_START_DATE
@@ Line 54: / Line 54: @@
 | style="border: 1px solid #010101" width="195" |
 The start date of Cati contact
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_END_DATE
@@ Line 61: / Line 61: @@
 | style="border: 1px solid #010101" width="195" |
 The end date of Cati contact
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_OUTCOME_STATUS_ID
@@ Line 68: / Line 68: @@
 | style="border: 1px solid #010101" width="195" |
 Status of Cati contact
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_OUTCOME_STATUS_AS_TEXT
@@ Line 75: / Line 75: @@
 | style="border: 1px solid #010101" width="195" |
 The text of contact_status_id
-|- align="left" valign="top"
+|- valign="top" align="left"
 | style="border: 1px solid #010101" width="330" |
 CATI_CONTACT_DESCRIPTION
@@ Line 82: / Line 82: @@
 | style="border: 1px solid #010101" width="195" |
 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
 |}
@@ Line 90: / Line 115: @@
 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)}}
+// <nowiki>{{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)}}</nowiki>
 '''Availability'''
 Version 5.8
-__NOTOC__
+__FORCETOC__
 <!-- imported from file: 8040.htm-->