Your browser don't permit web-fonts to be installed. Our websites use web-fonts based icons. For a better experience please allow your browser to use web-fonts.
We are hiring!
Deutsch | English | Español

2.6. Contact

The contact object provides methods to manage (create, update, delete etc.) your contact handles.

2.6.1. contact.create

Creates a new contact handle.

2.6.1.1. Input

Table 2.68. Parameters

ParameterDescriptionTypeRequiredDefault
typeType of contact contactType true 
nameFirst and lastname text255 true 
orgOrganisation/company text0255 false 
streetStreet address field 1 text64 true 
cityContact city text64 true 
pcContact postal code text10 true 
spContact state province text064 false 
ccContact country country true 
voiceContact phone number phone true 
faxContact fax number phone false 
emailContact email address email true 
remarksContact handle remarks remarks false 
protectionContact protection boolean false1
forceNewForce new contact handle creation boolean false0
extDataContact extra data extData false 
testingExecute command in testing mode boolean false0

2.6.1.2. Output

Table 2.69. Parameters

ParameterDescriptionTypeOptional
idContact handle id int  

2.6.2. contact.delete

Delete an existing contact handle.

2.6.2.1. Input

Table 2.70. Parameters

ParameterDescriptionTypeRequiredDefault
idContact handle id int true 
testingExecute command in testing mode boolean falsefalse

2.6.2.2. Output

No additional return parameters

2.6.3. contact.info

Get contact handle details.

2.6.3.1. Input

Table 2.71. Parameters

ParameterDescriptionTypeRequiredDefault
idContact handle id int true 
wideMore detailed output int false0

2.6.3.2. Output

Table 2.72. Parameters

ParameterDescriptionTypeOptional
contact   
... roIdContact handle id int  
... idContact handle id name int  
... typeType of contact handle contactType  
... nameFirst and lastname text255  
... orgOrganisation/company text0255  
... streetStreet address text255  
... cityCity text64  
... pcPostal code text10  
... spState province text064 Yes
... ccCountry country  
... voicePhone number phone  
... faxFax number phone Yes
... emailEmail address email  
... remarksContact handle remarks remarks Yes
... protectionContact handle protection boolean  
... usedCountTotal number of contact handle uses int Yes
... nicHandleContact NIC handle nicHandleList Yes

2.6.4. contact.list

List available contact handles.

2.6.4.1. Input

Table 2.73. Parameters

ParameterDescriptionTypeRequiredDefault
orderSort order of the result list contactOrder falseIDDESC
searchSearch string text64 false 
readOnlyList only readable contact handle int false 
pagePage number for paging int false1
pagelimitMax number of results per page int false20
withoutVerificationDon't return the Verification Status boolean false0
idRetrieve only this one contact. int false 

2.6.4.2. Output

Table 2.74. Parameters

ParameterDescriptionTypeOptional
countTotal number of contact handles int  
contact   
... roIdContact handle id (Repository Object Identifier) int  
... idContact handle id name int  
... typeType of contact handle contactType  
... nameFirst and lastname text255  
... orgOrganisation/company text0255  
... streetStreet address text255  
... cityCity text64  
... pcPostal code text10  
... spState province text064 Yes
... ccCountry country  
... voicePhone number phone  
... faxFax number phone Yes
... emailEmail adress email  
... remarksContact handle remarks remarks Yes
... protectionContact handle protection boolean  
... readOnlyContact handle is read only boolean  
... usedCountTotal number of contact handle uses int Yes
... verificationStatusContact Verification Status text64 Yes

2.6.5. contact.log

Log of changes to the contact handle.

2.6.5.1. Input

Table 2.75. Parameters

ParameterDescriptionTypeRequiredDefault
idContact handle id int false 

2.6.5.2. Output

Table 2.76. Parameters

ParameterDescriptionTypeOptional
countTotal number of log entries int  
contact   
... logIdId of the log entry int  
... dateLog timestamp dateTime  
... idId of the altered contact handle int  
... statusContact handle status after the action was performed text64  

2.6.6. contact.sendcontactverification

send Contact Verification

2.6.6.1. Input

Table 2.77. Parameters

ParameterDescriptionTypeRequiredDefault
idContact handle id int true 

2.6.6.2. Output

No additional return parameters

2.6.7. contact.update

Alter contact handle data.

2.6.7.1. Input

Table 2.78. Parameters

ParameterDescriptionTypeRequiredDefault
idContact handle id int true 
nameFirst and lastname text255 false 
orgOrganisation/company text0255 false 
streetStreet address field 1 text64 false 
cityCity text64 false 
pcPostal code text10 false 
spState province text064 false 
ccCountry country false 
voiceContact phone number text64 false 
faxContact fax number text064 false 
emailEmail address email false 
remarksContact handle remarks remarks false 
protectionContact handle protection boolean false 
extDataContact extra data extData false 
testingExecute command in testing mode boolean falsefalse

2.6.7.2. Output

No additional return parameters