|
Oracle CRM On Demand CTI Developer's Guide > CTI Integration APIs > CTI Activity Web Service >
CTIActivityInsert Interaction Output Parameters
The output parameters for the CTIActivityInsert method are shown in Table 5. The Status parameter is always returned, and indicates whether the activity creation was successful. If the value of the Status parameter is OK or Activity already exists, the ActivityId is always returned. If the value of the Status parameter is OK and the created activity is associated with other records, the records IDs and other record information are returned (for example, ContactId and ContactFullName). The various types for the output parameters (as shown in the Type column of Table 5) are listed in Table 4.
Table 5. CTIActivityInsert Method Output Parameters
|
|
|
AccountId |
String |
The ID of the account record associated with the activity. |
AccountName |
String |
The name of the account record associated with the activity. |
ActivityId |
String |
The ID of the activity created, or the activity that already existed. |
AgentOfferTime |
Date-time |
The same as for the AgentOfferTime input argument. The time that the interaction is offered to an agent (also known as System Offer Time). It is used like a default value for other parameters, like IVRBeginTime and QueueBeginTime. AgentOfferTime is also used as a primary key for differentiating activity records with the same InteractionId. |
CampaignId |
String |
The ID of the campaign record associated with the activity. |
CampaignName |
String |
The name of the campaign associated with the activity. |
ContactFullName |
String |
The full name of the contact associated with the activity. |
ContactId |
String |
The ID of the contact record associated with the activity. |
InteractionId |
String |
Part of the primary key of the activity, together with AgentOfferTime. |
LeadFullName |
String |
The full name of the lead associated with the activity. |
LeadId |
String |
The ID of the lead associated with the activity. |
ScreenPopRecordId |
String |
The record ID of the screen pop record. |
ScreenPopRecordType |
Record Type LOV |
The suggested record type for the screen pop record. The suggestion is based on the following priority order:
- Service Request
- Campaign
- Contact
- Lead
- Account
- Activity
For example, if the activity is associated with both a contact and an account, Contact is returned because that record type is higher in the priority list. The suggestion, together with the record associations returned, allows third-party vendors to choose the record type for the screen pop. |
ServiceRequestId |
String |
The ID of the service request record associated with the activity. |
ServiceRequestNumber |
String |
The number of the service request associated with the activity. |
Status |
String |
The status of the activity. This can have the following values:
OK.The activity was created successfully.
Activity already exists. An activity was created for this interaction before the request.
Unable to create activity. It was not possible to create the activity.
Error. There is an error.
These values are always returned in English, regardless of the user's locale. If there is an exception, an error message (see Table 8) is returned, and this may be translated. |
|
