1. References
  2. Management API
  3. CallerIDs
Rate this page:

CallerIDs

Methods

AddCallerID

Copy URL

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.

AddCallerID example
Copy

AddCallerID example

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

Copy URL

Activates the CallerID by the verification code.

ActivateCallerID example
Copy

ActivateCallerID example

Activate 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

Copy URL

Deletes the CallerID. Note: you can't delete a CID permanently (the antispam defence).

DelCallerID example
Copy

DelCallerID example

Delete the callerID 1.

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

Copy URL

Gets the account callerIDs.

GetCallerIDs example
Copy

GetCallerIDs example

Get the two callerIDs.

Parameters

  • callerid_id:

    number

    Optional

    The id of the callerID object to filter

  • callerid_number:

    string

    Optional

    The phone number to filter

  • active:

    boolean

    Optional

    The active flag to filter

  • order_by:

    string

    Optional

    The following values are available: 'caller_number' (ascent order), 'verified_until' (ascent order)

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records will be skipped in the output

Returns

  • result:

    [CallerIDInfoType]

  • total_count:

    number

    The total found record count

  • count:

    number

    The returned record count

VerifyCallerID

Copy URL

Gets a verification code via phone call to the callerid_number.

VerifyCallerID example
Copy

VerifyCallerID example

Verify the callerID 1.

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