CallerIDs
Methods
AddCallerID
Adds a new caller ID. Caller ID is the phone that will be displayed to the called user. This number can be used for call back.
Parameters
callerid_number:
string
The callerID number in E.164 format
Returns
result:
number
1
callerid_id:
number
The id of the callerID object
ActivateCallerID
Activates the CallerID by the verification code.
Parameters
callerid_id:
number
The id of the callerID object
callerid_number:
string
The callerID number that can be used instead of callerid_id
verification_code:
string
The verification code, see the VerifyCallerID function
Returns
result:
number
1
DelCallerID
Deletes the CallerID. Note: you can't delete a CID permanently (the antispam defence).
Parameters
callerid_id:
number
The id of the callerID object
callerid_number:
string
The callerID number that can be used instead of callerid_id
Returns
result:
number
1
GetCallerIDs
Gets the account callerIDs.
Parameters
callerid_id:
number
OptionalThe id of the callerID object to filter
callerid_number:
string
OptionalThe phone number to filter
active:
boolean
OptionalThe active flag to filter
order_by:
string
OptionalThe following values are available: 'caller_number' (ascent order), 'verified_until' (ascent order)
count:
number
OptionalDefaults on: 20The max returning record count
offset:
number
OptionalDefaults on: 0The first N records will be skipped in the output
Returns
result:
total_count:
number
The total found record count
count:
number
The returned record count
VerifyCallerID
Gets a verification code via phone call to the callerid_number.
Parameters
callerid_id:
number
The id of the callerID object
callerid_number:
string
The callerID number that can be used instead of callerid_id
Returns
result:
number
1