Toggle search
Toggle menu
862
3.8K
30.2K
279.1K
Catglobe Wiki
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

CATI getCATIContacts: Difference between revisions

From Catglobe Wiki
More actions
VisualWikitext
jrfconvert import
 
Nguyenduyan (talk | contribs)
Maysunshine
969 edits
No edit summary
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:HelpBooks]]
[[Category:Questionnaire_Functions]]

{{HelpFiles}}


====CATI_getCATIContacts====
====CATI_getCATIContacts====


This script is used to get information of Cati contact with specified RPQ Id
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'''
'''Syntax'''
Line 18: Line 18:
Array
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" |
| style="border: 1px solid #010101" width="330" bgcolor="#BFBFBF" |
'''Index'''
'''Index'''
Line 26: Line 26:
| style="border: 1px solid #010101" width="195" bgcolor="#BFBFBF" |
| style="border: 1px solid #010101" width="195" bgcolor="#BFBFBF" |
''' Value'''
''' Value'''
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
OBJECT_TYPE
OBJECT_TYPE
Line 33: Line 33:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |


|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_ID
CATI_CONTACT_ID
Line 40: Line 40:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
Id of Cati contact
Id of Cati contact
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_INTERVIEWER_USER_RESOURCE_ID
CATI_CONTACT_INTERVIEWER_USER_RESOURCE_ID
Line 47: Line 47:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
The interviewer resource id of Cati contact
The interviewer resource id of Cati contact
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_START_DATE
CATI_CONTACT_START_DATE
Line 54: Line 54:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
The start date of Cati contact
The start date of Cati contact
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_END_DATE
CATI_CONTACT_END_DATE
Line 61: Line 61:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
The end date of Cati contact
The end date of Cati contact
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_OUTCOME_STATUS_ID
CATI_CONTACT_OUTCOME_STATUS_ID
Line 68: Line 68:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
Status of Cati contact
Status of Cati contact
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_OUTCOME_STATUS_AS_TEXT
CATI_CONTACT_OUTCOME_STATUS_AS_TEXT
Line 75: Line 75:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
The text of contact_status_id
The text of contact_status_id
|- align="left" valign="top"
|- valign="top" align="left"
| style="border: 1px solid #010101" width="330" |
| style="border: 1px solid #010101" width="330" |
CATI_CONTACT_DESCRIPTION
CATI_CONTACT_DESCRIPTION
Line 82: Line 82:
| style="border: 1px solid #010101" width="195" |
| style="border: 1px solid #010101" width="195" |
Description of Cati contact
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'''
'''Example'''
<source lang="javascript">
array a = CATI_getCATIContacts(61209933);
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}}


array a = CATI_getCATIContacts(123456);
</source>


'''Availability'''
'''Availability'''


Version 5.8
Version 5.8
__NOTOC__
 
__FORCETOC__
<!-- imported from file: 8040.htm-->
<!-- imported from file: 8040.htm-->

Latest revision as of 04:08, 19 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

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(61209933);
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


Retrieved from "https://testwiki.catglobe.com/index.php?title=CATI_getCATIContacts&oldid=238385"